Skip to content

Commit c266075

Browse files
fmbenhassinefmbenhassine
committed
Attach Javadocs to Antora docs
1 parent 9c22caf commit c266075

File tree

12 files changed

+47
-93
lines changed

12 files changed

+47
-93
lines changed

‎.github/workflows/continuous-integration.yml‎

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -32,36 +32,3 @@ jobs:
3232
folder: 'deployment-repository'
3333
signing-key: ${{ secrets.GPG_PRIVATE_KEY }}
3434
signing-passphrase: ${{ secrets.GPG_PASSPHRASE }}
35-
36-
- name: Generate Java docs
37-
run: mvn javadoc:aggregate
38-
39-
- name: Generate Assembly
40-
working-directory: spring-batch-docs
41-
run: mvn assembly:single
42-
43-
- name: Capture project version
44-
run: echo PROJECT_VERSION=$(mvn help:evaluate -Dexpression=project.version --quiet -DforceStdout) >> $GITHUB_ENV
45-
46-
- name: Setup SSH key
47-
if: ${{ github.repository == 'spring-projects/spring-batch' && github.ref_name == 'main' }}
48-
env:
49-
DOCS_SSH_KEY: ${{ secrets.DOCS_SSH_KEY }}
50-
DOCS_SSH_HOST_KEY: ${{ secrets.DOCS_SSH_HOST_KEY }}
51-
run: |
52-
mkdir "$HOME/.ssh"
53-
echo "$DOCS_SSH_KEY" > "$HOME/.ssh/key"
54-
chmod 600 "$HOME/.ssh/key"
55-
echo "$DOCS_SSH_HOST_KEY" > "$HOME/.ssh/known_hosts"
56-
57-
- name: Deploy Java docs
58-
if: ${{ github.repository == 'spring-projects/spring-batch' && github.ref_name == 'main' }}
59-
env:
60-
DOCS_HOST: ${{ secrets.DOCS_HOST }}
61-
DOCS_PATH: ${{ secrets.DOCS_PATH }}
62-
DOCS_USERNAME: ${{ secrets.DOCS_USERNAME }}
63-
working-directory: spring-batch-docs/target
64-
run: |
65-
unzip spring-batch-$PROJECT_VERSION-javadocs.zip
66-
ssh -i $HOME/.ssh/key $DOCS_USERNAME@$DOCS_HOST "cd $DOCS_PATH && mkdir -p $PROJECT_VERSION"
67-
scp -i $HOME/.ssh/key -r api $DOCS_USERNAME@$DOCS_HOST:$DOCS_PATH/$PROJECT_VERSION

‎.github/workflows/documentation-upload.yml‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@ jobs:
2828
- name: Update release version
2929
run: mvn versions:set -DgenerateBackupPoms=false -DnewVersion=$RELEASE_VERSION
3030

31-
- name: Generate Java docs
32-
run: mvn javadoc:aggregate
33-
3431
- name: Generate Assembly
3532
working-directory: spring-batch-docs
3633
run: mvn assembly:single
@@ -45,7 +42,7 @@ jobs:
4542
chmod 600 "$HOME/.ssh/key"
4643
echo "$DOCS_SSH_HOST_KEY" > "$HOME/.ssh/known_hosts"
4744
48-
- name: Deploy Java docs and xsd schemas
45+
- name: Deploy xsd schemas
4946
env:
5047
DOCS_HOST: ${{ secrets.DOCS_HOST }}
5148
DOCS_PATH: ${{ secrets.DOCS_PATH }}
@@ -54,10 +51,6 @@ jobs:
5451
INTEGRATION_SCHEMA_PATH: ${{ secrets.INTEGRATION_SCHEMA_PATH }}
5552
working-directory: spring-batch-docs/target
5653
run: |
57-
unzip spring-batch-$RELEASE_VERSION-javadocs.zip
58-
ssh -i $HOME/.ssh/key $DOCS_USERNAME@$DOCS_HOST "cd $DOCS_PATH && mkdir -p $RELEASE_VERSION"
59-
scp -i $HOME/.ssh/key -r api $DOCS_USERNAME@$DOCS_HOST:$DOCS_PATH/$RELEASE_VERSION
60-
6154
unzip spring-batch-$RELEASE_VERSION-schemas.zip
6255
scp -i $HOME/.ssh/key batch/*.xsd $DOCS_USERNAME@$DOCS_HOST:$BATCH_SCHEMA_PATH
6356
scp -i $HOME/.ssh/key batch-integration/*.xsd $DOCS_USERNAME@$DOCS_HOST:$INTEGRATION_SCHEMA_PATH

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,3 @@ out
3030
node
3131
node_modules
3232
package-lock.json
33-
package.json

‎README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,7 @@ Please note that some integration tests are based on Docker, so please make sure
182182
To generate the reference documentation, run the following commands:
183183

184184
```
185-
$ cd spring-batch-docs
186-
$ ../mvnw antora:antora
185+
$ ./mvnw antora -pl spring-batch-docs
187186
```
188187

189188
The reference documentation can be found in `spring-batch-docs/target/anotra/site`.

‎pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@
133133

134134
<!-- documentation dependencies -->
135135
<io.spring.maven.antora-version>0.0.4</io.spring.maven.antora-version>
136+
<antora-maven-plugin.version>1.0.0-alpha.5</antora-maven-plugin.version>
136137

137138
<!-- plugin versions -->
138139
<maven-compiler-plugin.version>3.14.0</maven-compiler-plugin.version>

‎spring-batch-docs/antora-playbook.yml‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
# The purpose of this Antora playbook is to build the docs in the current branch.
21
antora:
32
extensions:
4-
- '@springio/antora-extensions/partial-build-extension'
5-
- '@antora/atlas-extension'
6-
- require: '@springio/antora-extensions/latest-version-extension'
7-
- require: '@springio/antora-extensions/inject-collector-cache-config-extension'
8-
- '@antora/collector-extension'
9-
- require: '@springio/antora-extensions/root-component-extension'
3+
- require: '@springio/antora-extensions'
104
root_component_name: 'batch'
11-
- '@springio/antora-extensions/static-page-extension'
125
site:
136
title: Spring Batch Reference
147
url: https://docs.spring.io/spring-batch/reference
8+
robots: allow
9+
git:
10+
ensure_git_suffix: false
1511
content:
1612
sources:
1713
- url: ..
@@ -20,21 +16,26 @@ content:
2016
worktrees: true
2117
asciidoc:
2218
attributes:
19+
page-stackoverflow-url: https://stackoverflow.com/tags/spring-batch
2320
page-pagination: ''
2421
hide-uri-scheme: '@'
2522
tabs-sync-option: '@'
2623
chomp: 'all'
24+
attribute-missing: 'warn'
25+
sourcemap: true
2726
extensions:
2827
- '@asciidoctor/tabs'
2928
- '@springio/asciidoctor-extensions'
30-
sourcemap: true
29+
- '@springio/asciidoctor-extensions/javadoc-extension'
3130
urls:
31+
latest_version_segment_strategy: redirect:to
3232
latest_version_segment: ''
33+
redirect_facility: httpd
34+
ui:
35+
bundle:
36+
url: https://github.com/spring-io/antora-ui-spring/releases/download/latest/ui-bundle.zip
37+
snapshot: true
3338
runtime:
3439
log:
3540
failure_level: warn
36-
format: pretty
37-
ui:
38-
bundle:
39-
url: https://github.com/spring-io/antora-ui-spring/releases/download/v0.4.18/ui-bundle.zip
40-
snapshot: true
41+
format: pretty

‎spring-batch-docs/antora.yml‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,15 @@ nav:
55
- modules/ROOT/nav.adoc
66
ext:
77
collector:
8-
run:
9-
command: ./mvnw process-resources -pl spring-batch-docs -am
10-
scan:
11-
dir: ./target/classes/antora-resources
8+
- run:
9+
command: ./mvnw process-resources -pl spring-batch-docs
10+
local: true
11+
scan:
12+
dir: ./target/classes/antora-resources
13+
- run:
14+
command: ./mvnw javadoc:aggregate
15+
local: true
16+
scan:
17+
clean: true
18+
dir: target/reports/apidocs
19+
into: modules/api/attachments

‎spring-batch-docs/modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,4 @@
6161
** xref:transaction-appendix.adoc[]
6262
** xref:glossary.adoc[]
6363
** xref:faq.adoc[]
64+
* xref:api:attachment$index.html[Javadoc,role=link-external,window=_blank]

‎spring-batch-docs/package.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"dependencies": {
3+
"antora": "3.2.0-alpha.9",
4+
"@antora/atlas-extension": "1.0.0-alpha.5",
5+
"@antora/collector-extension": "1.0.2",
6+
"@asciidoctor/tabs": "1.0.0-beta.6",
7+
"@springio/antora-extensions": "1.14.7",
8+
"@springio/asciidoctor-extensions": "1.0.0-alpha.17"
9+
}
10+
}

‎spring-batch-docs/pom.xml‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,15 @@
1717
<build>
1818
<plugins>
1919
<plugin>
20-
<groupId>io.spring.maven.antora</groupId>
20+
<groupId>org.antora</groupId>
2121
<artifactId>antora-maven-plugin</artifactId>
22-
<version>${io.spring.maven.antora-version}</version>
22+
<version>${antora-maven-plugin.version}</version>
2323
<extensions>true</extensions>
2424
<configuration>
25-
<packages>
26-
<package>@antora/atlas-extension@1.0.0-alpha.2</package>
27-
<package>@antora/collector-extension@1.0.1</package>
28-
<package>@asciidoctor/tabs@1.0.0-beta.6</package>
29-
<package>@springio/antora-extensions@1.14.7</package>
30-
<package>@springio/asciidoctor-extensions@1.0.0-alpha.17</package>
31-
</packages>
25+
<environmentVariables>
26+
<BUILD_REFNAME>HEAD</BUILD_REFNAME>
27+
<BUILD_VERSION>${project.version}</BUILD_VERSION>
28+
</environmentVariables>
3229
</configuration>
3330
</plugin>
3431
<plugin>
@@ -49,7 +46,6 @@
4946
<version>${maven-assembly-plugin.version}</version>
5047
<configuration>
5148
<descriptors>
52-
<descriptor>src/assembly/javadocs.xml</descriptor>
5349
<descriptor>src/assembly/schemas.xml</descriptor>
5450
</descriptors>
5551
<finalName>spring-batch-${project.version}</finalName>

0 commit comments

Comments
 (0)