Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,11 @@ updates:
github-actions:
patterns:
- "*"
- package-ecosystem: "maven"
directory: "/docs"
schedule:
interval: "weekly"
- package-ecosystem: "npm"
directory: "/docs"
schedule:
interval: "weekly"
14 changes: 13 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,19 @@ jobs:
java-version: '21'
cache: 'maven'
- name: Build with Maven
run: ./mvnw -B verify javadoc:javadoc
run: ./mvnw -B install javadoc:javadoc
- name: Set up Node.js
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
with:
node-version: '26'
- name: Generate documentation
run: ./mvnw -B -f docs test-compile antora -Dnode.executable=node
- name: Upload documentation
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: docs
if-no-files-found: error
path: docs/target/site
# - name: Sonar Analysis
# if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository }}
# run: ./mvnw -B sonar:sonar
Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/node_modules
/target
17 changes: 17 additions & 0 deletions docs/antora-playbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
antora:
extensions:
- '@antora/collector-extension'
site:
title: AssertJ Docs
start_page: assertj-db::index.adoc
content:
sources:
- url: ./.. # the local repository, relative to this playbook
branches: HEAD # use the worktree so that uncommitted changes are included
start_path: docs
ui:
bundle:
url: https://github.com/assertj/antora-ui/releases/latest/download/ui-bundle.zip
snapshot: true
output:
dir: ./target/site
19 changes: 19 additions & 0 deletions docs/antora-resources/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
version: ${antora-component.version}
prerelease: ${antora-component.prerelease}
asciidoc:
attributes:
idprefix: ''
idseparator: '-'
tabsize: '3'
source-indent: '0'
assertj-db-version: '${project.version}'
assertj-core-github: 'https://github.com/assertj/assertj'
assertj-doc-github: 'https://github.com/assertj/doc'
assertj-examples-github: 'https://github.com/assertj/assertj-examples'
assertj-examples-base-package: 'https://github.com/assertj/assertj-examples/blob/main/assertions-examples/src/test/java/org/assertj/examples'
assertj-guava-github: 'https://github.com/assertj/assertj'
assertj-swing-github: 'https://github.com/assertj/assertj-swing'
release-branch: 'main'
current-branch: 'https://github.com/assertj/assertj/tree/main'
AssertJ: 'https://assertj.github.io/doc/[AssertJ]'
StackOverflow: 'https://stackoverflow.com/questions/tagged/assertj[Stack Overflow]'
14 changes: 14 additions & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: assertj-db
title: AssertJ DB
version: true
nav:
- modules/ROOT/nav.adoc
ext:
collector:
- run:
command: ./mvnw -q -f docs process-resources
local: true
scan:
- dir: docs/target/antora
- dir: docs/src/test/java
into: modules/ROOT/examples/java
Binary file added docs/modules/ROOT/images/assertj-db_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/modules/ROOT/images/db-changes-concept.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
* xref:index.adoc[Overview]
* xref:quickstart.adoc[]
* xref:concepts.adoc[]
* xref:features.adoc[]
* xref:release-notes.adoc[]
Loading