Skip to content

Commit 8bbb5cb

Browse files
committed
set up github javadoc publishing
1 parent 328bcfe commit 8bbb5cb

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

‎.github/javadoc.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Publish Javadoc
2+
3+
on:
4+
push:
5+
tags:
6+
- 'SNT-*' # matches tags created by release-version.sh, e.g. SNT-4.3.0
7+
8+
jobs:
9+
javadoc:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout source
14+
uses: actions/checkout@v4
15+
16+
- name: Set up Java
17+
uses: actions/setup-java@v4
18+
with:
19+
java-version: '21'
20+
distribution: 'temurin'
21+
cache: maven
22+
23+
- name: Generate javadoc
24+
# -q suppresses Maven build output; javadoc warnings still show.
25+
# Output lands in target/site/apidocs/
26+
run: mvn -B -q javadoc:javadoc -Ddoclint=none
27+
28+
- name: Deploy to gh-pages
29+
uses: peaceiris/actions-gh-pages@v4
30+
with:
31+
github_token: ${{ secrets.GITHUB_TOKEN }}
32+
publish_dir: target/site/apidocs
33+
# Each release overwrites the previous docs (no history accumulation).
34+
force_orphan: true

0 commit comments

Comments
 (0)