Skip to content

Commit e4995f9

Browse files
committed
Attach Javadocs to Antora docs
1 parent 02cbe72 commit e4995f9

File tree

4 files changed

+13
-106
lines changed

4 files changed

+13
-106
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -39,28 +39,3 @@ jobs:
3939
folder: 'deployment-repository'
4040
signing-key: ${{ secrets.GPG_PRIVATE_KEY }}
4141
signing-passphrase: ${{ secrets.GPG_PASSPHRASE }}
42-
43-
- name: Setup SSH key
44-
env:
45-
DOCS_SSH_KEY: ${{ secrets.DOCS_SSH_KEY }}
46-
DOCS_SSH_HOST_KEY: ${{ secrets.DOCS_SSH_HOST_KEY }}
47-
run: |
48-
mkdir "$HOME/.ssh"
49-
echo "$DOCS_SSH_KEY" > "$HOME/.ssh/key"
50-
chmod 600 "$HOME/.ssh/key"
51-
echo "$DOCS_SSH_HOST_KEY" > "$HOME/.ssh/known_hosts"
52-
53-
- name: Capture project version
54-
run: echo PROJECT_VERSION=$(./mvnw help:evaluate -Dexpression=project.version --quiet -DforceStdout) >> $GITHUB_ENV
55-
56-
- name: Generate Java docs
57-
run: ./mvnw --no-transfer-progress javadoc:aggregate
58-
59-
- name: Deploy Javadocs
60-
env:
61-
DOCS_HOST: ${{ secrets.DOCS_HOST }}
62-
DOCS_USERNAME: ${{ secrets.DOCS_USERNAME }}
63-
DOCS_PATH: /opt/www/domains/spring.io/docs/htdocs/spring-shell
64-
run: |
65-
ssh -i $HOME/.ssh/key $DOCS_USERNAME@$DOCS_HOST "cd $DOCS_PATH/docs && mkdir -p $PROJECT_VERSION"
66-
scp -i $HOME/.ssh/key -r target/reports/apidocs $DOCS_USERNAME@$DOCS_HOST:$DOCS_PATH/docs/$PROJECT_VERSION/api

.github/workflows/documentation-upload.yml

Lines changed: 0 additions & 76 deletions
This file was deleted.

spring-shell-docs/antora.yml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,15 @@ nav:
55
- modules/ROOT/nav.adoc
66
ext:
77
collector:
8-
run:
9-
command: mvnw process-resources -pl spring-shell-docs
10-
local: true
11-
scan:
12-
dir: ./target/classes/antora-resources
8+
- run:
9+
command: ./mvnw process-resources -pl spring-shell-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-shell-docs/modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,4 @@
9797
** xref:appendices/tui/index.adoc[]
9898
*** xref:appendices/tui/viewdev.adoc[]
9999
*** xref:appendices/tui/catalog.adoc[]
100+
* xref:api:attachment$index.html[Javadoc,role=link-external,window=_blank].

0 commit comments

Comments
 (0)