diff --git a/spring-graphql-docs/.github/workflows/deploy-docs.yml b/spring-graphql-docs/.github/workflows/deploy-docs.yml new file mode 100644 index 00000000..1435fc21 --- /dev/null +++ b/spring-graphql-docs/.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/spring-graphql-docs/antora-playbook.yml b/spring-graphql-docs/antora-playbook.yml new file mode 100644 index 00000000..ffae717c --- /dev/null +++ b/spring-graphql-docs/antora-playbook.yml @@ -0,0 +1,36 @@ +# PACKAGES antora@3.2.0-alpha.2 @antora/atlas-extension:1.0.0-alpha.1 @antora/collector-extension@1.0.0-alpha.3 @springio/antora-extensions@1.1.0-alpha.2 @asciidoctor/tabs@1.0.0-alpha.12 @opendevise/antora-release-line-extension@1.0.0-alpha.2 +# +# The purpose of this Antora playbook is to build the docs in the current branch. +antora: + extensions: + - '@antora/collector-extension' + - require: '@springio/antora-extensions/tabs-migration-extension' + unwrap_example_block: always +site: + title: Spring Framework Reference + url: https://https://rwinch.github.io/spring-framework/ +content: + sources: + - url: https://github.com/rwinch/spring-framework + branches: ./.. + start_path: framework-docs + worktrees: true +asciidoc: + attributes: + 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 +ui: + bundle: + url: https://github.com/spring-io/antora-ui-spring/releases/download/latest/ui-bundle.zip + snapshot: true \ No newline at end of file diff --git a/spring-graphql-docs/antora.yml b/spring-graphql-docs/antora.yml new file mode 100644 index 00000000..cc7d6eb1 --- /dev/null +++ b/spring-graphql-docs/antora.yml @@ -0,0 +1,32 @@ +name: framework +version: true +title: Spring Framework Documentation +nav: + - modules/ROOT/nav.adoc +ext: + collector: + run: + command: gradlew -q -PbuildSrc.skipTests=true "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-boot-project:spring-boot-docs:generateAntoraResources + local: true + scan: + dir: ./build/generated-antora-resources + +asciidoc: + attributes: + attribute-missing: 'warn' + # FIXME: the copyright is not removed + # FIXME: The package is not renamed + chomp: 'all' + import-java: 'example$docs-src/main/java/org/springframework/docs' + spring-framework-main-code: 'https://github.com/spring-projects/spring-framework/tree/main' + docs-site: 'https://docs.spring.io' + docs-spring: "{docs-site}/spring-framework/docs/{spring-version}" + docs-spring-framework: '{docs_site}/spring-framework/docs/{spring-version}' + api-spring-framework: '{docs-spring-framework}/javadoc-api/org/springframework' + docs-graalvm: 'https://www.graalvm.org/22.3/reference-manual' + docs-spring-boot: '{docs-site}/spring-boot/docs/current/reference' + docs-spring-gemfire: '{docs_site}/spring-gemfire/docs/current/reference' + docs-spring-security: '{docs_site}/spring-security/reference' + gh-rsocket: 'https://github.com/rsocket' + gh-rsocket-extensions: '{gh-rsocket}/rsocket/blob/master/Extensions' + gh-rsocket-java: '{gh-rsocket}/rsocket-java{gh-rsocket}/rsocket-java' \ No newline at end of file