diff --git a/docs/modules/.github/workflows/deploy-docs.yml b/docs/modules/.github/workflows/deploy-docs.yml new file mode 100644 index 00000000..9d272779 --- /dev/null +++ b/docs/modules/.github/workflows/deploy-docs.yml @@ -0,0 +1,33 @@ +name: Deploy Docs +on: + push: + branches-ignore: [ gh-pages ] + tags: '**' + repository_dispatch: + types: request-build-reference # legacy + #schedule: + #- cron: '0 10 * * *' # Once per day at 10am UTC + workflow_dispatch: +permissions: + actions: write +jobs: + build: + runs-on: ubuntu-latest + # FIXME: enable when pushed to spring-projects + # if: github.repository_owner == 'spring-projects' + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + ref: docs-build + fetch-depth: 1 + - name: Dispatch (partial build) + if: github.ref_type == 'branch' + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD) -f build-refname=${{ github.ref_name }} + - name: Dispatch (full build) + if: github.ref_type == 'tag' + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD) diff --git a/docs/modules/antora-playbook.yml b/docs/modules/antora-playbook.yml new file mode 100644 index 00000000..2ea33704 --- /dev/null +++ b/docs/modules/antora-playbook.yml @@ -0,0 +1,46 @@ +antora: + extensions: + - '@springio/antora-extensions/partial-build-extension' + - require: '@springio/antora-extensions/latest-version-extension' + - require: '@springio/antora-extensions/inject-collector-cache-config-extension' + - '@antora/collector-extension' + - '@antora/atlas-extension' + - require: '@springio/antora-extensions/root-component-extension' + root_component_name: 'shell' # FIXME: Change this to match `name:` in antora.yml + # FIXME: Run antora once using this extension to migrate to the Asciidoc Tabs syntax + # and then remove this extension + - require: '@springio/antora-extensions/tabs-migration-extension' + unwrap_example_block: always + save_result: true +site: + title: Spring Shell # FIXME: Change to your Project's title + url: https://docs.spring.io/spring-shell/reference/ # FIXME: Change to your Project's URL +content: + sources: + - url: ./.. + branches: HEAD + # FIXME: Change this to the path to the directory containing antora.yml in your project + # See https://docs.antora.org/antora/latest/playbook/content-source-start-path/#start-path-key + start_path: spring-shell-docs + worktrees: true +asciidoc: + attributes: + # FIXME: Change to your stackoverflow URL or remove + page-stackoverflow-url: https://stackoverflow.com/tags/spring-shell + page-pagination: '' + hide-uri-scheme: '@' + tabs-sync-option: '@' + chomp: 'all' + extensions: + - '@asciidoctor/tabs' + - '@springio/asciidoctor-extensions' + sourcemap: true +urls: + latest_version_segment: '' +runtime: + log: + failure_level: warn + format: pretty +ui: + bundle: + url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.4/ui-bundle.zip \ No newline at end of file diff --git a/docs/modules/antora.yml b/docs/modules/antora.yml new file mode 100644 index 00000000..d50c53b4 --- /dev/null +++ b/docs/modules/antora.yml @@ -0,0 +1,25 @@ +name: shell # FIXME: Change to your project name typically just remove spring- from the artifact name +version: true +title: Spring Shell # FIXME: Change to the title of your Project's docs +nav: + - modules/ROOT/nav.adoc +ext: + collector: + run: + # FIXME Change "command" to the command that generates your antora.yml and other antora resources + # See https://gitlab.com/antora/antora-collector-extension/-/blob/main/docs/modules/ROOT/pages/configuration-keys.adoc?ref_type=heads#collector-reference + # HINT: Maven is typically something like: + # ./mvnw validate process-resources -am -Pantora-process-resources + command: gradlew -q "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-shell-docs:generateAntoraYml + local: true + scan: + # FIXME Change "dir" to the location that generated files are at + # See https://gitlab.com/antora/antora-collector-extension/-/blob/main/docs/modules/ROOT/pages/configuration-keys.adoc?ref_type=heads#collector-reference + # HINT: Maven is typically something like: + # target/classes/antora-resources/ + dir: ./build/generated-antora-resources + +asciidoc: + attributes: + attribute-missing: 'warn' + chomp: 'all' \ No newline at end of file