Skip to content

Commit c6c34eb

Browse files
authored
Merge pull request #227 from centreformicrosimulation/documentation/setup-javadoc-workflow
Create publish-javadoc.yml
2 parents d7ea260 + 22496b0 commit c6c34eb

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Publish Javadoc
2+
3+
on:
4+
push:
5+
branches:
6+
- develop # Only publish when pushing to develop branch
7+
8+
jobs:
9+
publish-javadoc:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: write # Needed to push to the javadoc branch
13+
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@v3
17+
18+
- name: Set up JDK 19
19+
uses: actions/setup-java@v3
20+
with:
21+
java-version: '19'
22+
distribution: 'temurin'
23+
cache: maven
24+
25+
- name: Build (optional if Javadoc needs compiled sources)
26+
run: mvn -B compile --file pom.xml
27+
28+
- name: Generate Javadoc
29+
run: mvn javadoc:javadoc --file pom.xml
30+
31+
- name: Deploy Javadoc to branch
32+
uses: MathieuSoysal/Javadoc-publisher.yml@v3.0.2
33+
with:
34+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35+
javadoc-branch: javadoc # Branch to store Javadoc
36+
java-version: 19
37+
target-folder: target/site/apidocs # Javadoc output directory
38+
project: maven

0 commit comments

Comments
 (0)