Copy default antora files
This commit is contained in:
32
docs/.github/workflows/deploy-docs.yml
vendored
Normal file
32
docs/.github/workflows/deploy-docs.yml
vendored
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
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
|
||||||
|
# if: github.repository_owner == 'spring-cloud'
|
||||||
|
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)
|
||||||
43
docs/antora-playbook.yml
Normal file
43
docs/antora-playbook.yml
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
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: 'PROJECT_WITHOUT_SPRING'
|
||||||
|
# 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: PROJECT_FULL_NAME
|
||||||
|
url: https://docs.spring.io/PROJECT_NAME/reference/
|
||||||
|
content:
|
||||||
|
sources:
|
||||||
|
- url: ./..
|
||||||
|
branches: HEAD
|
||||||
|
start_path: docs
|
||||||
|
worktrees: true
|
||||||
|
asciidoc:
|
||||||
|
attributes:
|
||||||
|
page-stackoverflow-url: https://stackoverflow.com/tags/spring-cloud
|
||||||
|
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.5/ui-bundle.zip
|
||||||
12
docs/antora.yml
Normal file
12
docs/antora.yml
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
name: PROJECT_WITHOUT_SPRING
|
||||||
|
version: true
|
||||||
|
title: PROJECT_NAME
|
||||||
|
nav:
|
||||||
|
- modules/ROOT/nav.adoc
|
||||||
|
ext:
|
||||||
|
collector:
|
||||||
|
run:
|
||||||
|
command: ./mvnw --no-transfer-progress -B process-resources -Pdocs -pl docs -Dantora-maven-plugin.phase=none -Dgenerate-docs.phase=none -Dgenerate-readme.phase=none -Dgenerate-cloud-resources.phase=none -Dmaven-dependency-plugin-for-docs.phase=none -Dmaven-dependency-plugin-for-docs-classes.phase=none -DskipTests
|
||||||
|
local: true
|
||||||
|
scan:
|
||||||
|
dir: ./target/classes/antora-resources/
|
||||||
Reference in New Issue
Block a user