Skip to content

Commit b574997

Browse files
committed
doc: generate javadoc
1 parent dfa344f commit b574997

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: javadoc-generation.yml
2+
3+
on:
4+
push:
5+
tags:
6+
- v2.**
7+
workflow_dispatch:
8+
9+
jobs:
10+
publish:
11+
runs-on: ubuntu-latest
12+
# permissions:
13+
# contents: write # if you have a protection rule on your repository, you'll need to give write permission to the workflow.
14+
steps:
15+
- name: Deploy JavaDoc 🚀
16+
uses: MathieuSoysal/Javadoc-publisher.yml@v3.0.2
17+
with:
18+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
19+
javadoc-branch: javadoc
20+
java-version: 11
21+
target-folder: javadoc # url will be https://<username>.github.io/<repo>/javadoc, This can be left as nothing to generate javadocs in the root folder.
22+
project: maven # or gradle
23+
# subdirectories: moduleA moduleB #for subdirectories support, needs to be run with custom command

0 commit comments

Comments
 (0)