Skip to content

Commit 6548e05

Browse files
bactgoneall
authored andcommitted
Generate Java doc website
Signed-off-by: Arthit Suriyawongkul <[email protected]>
1 parent 0327a01 commit 6548e05

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

.github/workflows/docs.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# SPDX-FileCopyrightText: 2025 SPDX contributors
2+
# SPDX-FileType: SOURCE
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
name: Generate and publish API JavaDocs
6+
on:
7+
push:
8+
branches: [ master ]
9+
workflow_dispatch:
10+
11+
jobs:
12+
docs:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0
19+
- uses: actions/setup-java@v4
20+
with:
21+
distribution: 'temurin'
22+
java-version: 21
23+
- name: Cache Maven packages
24+
uses: actions/cache@v4
25+
with:
26+
path: ~/.m2
27+
key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
28+
29+
- name: Generate docs
30+
run: mvn javadoc:javadoc
31+
32+
- name: Deploy docs
33+
uses: peaceiris/actions-gh-pages@v4
34+
with:
35+
github_token: ${{ secrets.GITHUB_TOKEN }}
36+
publish_dir: ./target/reports/apidocs

0 commit comments

Comments
 (0)