Skip to content

Commit 02964ae

Browse files
committed
Copy default antora files
1 parent ca59c54 commit 02964ae

File tree

3 files changed

+97
-0
lines changed

3 files changed

+97
-0
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Deploy Docs
2+
on:
3+
push:
4+
branches-ignore: [ gh-pages ]
5+
tags: '**'
6+
repository_dispatch:
7+
types: request-build-reference # legacy
8+
#schedule:
9+
#- cron: '0 10 * * *' # Once per day at 10am UTC
10+
workflow_dispatch:
11+
permissions:
12+
actions: write
13+
jobs:
14+
build:
15+
runs-on: ubuntu-latest
16+
# FIXME enable when pushed to spring-projects
17+
# if: github.repository_owner == 'spring-projects'
18+
steps:
19+
- name: Checkout
20+
uses: actions/checkout@v3
21+
with:
22+
ref: docs-build
23+
fetch-depth: 1
24+
- name: Dispatch (partial build)
25+
if: github.ref_type == 'branch'
26+
env:
27+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
28+
run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD) -f build-refname=${{ github.ref_name }}
29+
- name: Dispatch (full build)
30+
if: github.ref_type == 'tag'
31+
env:
32+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
33+
run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD)

spring-shell-docs/antora-playbook.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# 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
2+
#
3+
# The purpose of this Antora playbook is to build the docs in the current branch.
4+
antora:
5+
extensions:
6+
- '@springio/antora-extensions/partial-build-extension'
7+
- require: '@springio/antora-extensions/latest-version-extension'
8+
- require: '@springio/antora-extensions/inject-collector-cache-config-extension'
9+
- '@antora/collector-extension'
10+
- '@antora/atlas-extension'
11+
- require: '@springio/antora-extensions/root-component-extension'
12+
root_component_name: 'shell'
13+
- require: '@springio/antora-extensions/tabs-migration-extension'
14+
unwrap_example_block: always
15+
save_result: true
16+
site:
17+
title: Spring Shell
18+
url: https://docs.spring.io/spring-shell/reference/
19+
content:
20+
sources:
21+
- url: ./..
22+
branches: HEAD
23+
start_path: spring-shell-docs
24+
worktrees: true
25+
asciidoc:
26+
attributes:
27+
page-stackoverflow-url: https://stackoverflow.com/tags/spring-shell
28+
page-pagination: ''
29+
hide-uri-scheme: '@'
30+
tabs-sync-option: '@'
31+
chomp: 'all'
32+
extensions:
33+
- '@asciidoctor/tabs'
34+
- '@springio/asciidoctor-extensions'
35+
sourcemap: true
36+
urls:
37+
latest_version_segment: ''
38+
runtime:
39+
log:
40+
failure_level: warn
41+
format: pretty
42+
ui:
43+
bundle:
44+
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.3.4/ui-bundle.zip

spring-shell-docs/antora.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: shell
2+
version: true
3+
title: Spring Shell
4+
nav:
5+
- modules/ROOT/nav.adoc
6+
ext:
7+
collector:
8+
run:
9+
command: gradlew -q "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :spring-shell-docs:generateAntoraYml
10+
local: true
11+
scan:
12+
dir: ./build/generated-antora-resources
13+
14+
asciidoc:
15+
attributes:
16+
attribute-missing: 'warn'
17+
# FIXME: the copyright is not removed
18+
# FIXME: The package is not renamed
19+
chomp: 'all'
20+
snippets: example$docs-src/test/java/org/springframework/shell/docs

0 commit comments

Comments
 (0)