Skip to content

Commit ade7323

Browse files
authored
Render JavaDoc using GitHub Actions (FoundryMC#22)
* Create publish-javadoc.yml * Javadoc no failOnError * Update publish-javadoc.yml * Update publish-javadoc.yml * Update publish-javadoc.yml * Update publish-javadoc.yml * Update publish-javadoc.yml * Update publish-javadoc.yml
1 parent 1e1f8dd commit ade7323

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

Diff for: .github/workflows/publish-javadoc.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Deploy Javadoc
2+
3+
on:
4+
push:
5+
branches:
6+
- 1.20
7+
8+
jobs:
9+
publish:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: write # if you have a protection rule on your repository, you'll need to give write permission to the workflow.
13+
steps:
14+
- uses: actions/checkout@v4
15+
with:
16+
fetch-depth: 0
17+
18+
- name: Debug - List directory contents
19+
run: |
20+
pwd
21+
ls -R
22+
23+
- name: Deploy JavaDoc 🚀
24+
uses: MathieuSoysal/[email protected]
25+
with:
26+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
27+
javadoc-branch: javadoc
28+
java-version: 17
29+
javadoc-source-folder: common/build/docs/javadoc
30+
project: gradle
31+
32+
33+
- name: Debug - List directory contents
34+
run: |
35+
pwd
36+
ls -R
37+
if: always()

Diff for: build.gradle

+5
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ subprojects {
1212

1313
java.toolchain.languageVersion = JavaLanguageVersion.of(17)
1414
java.withSourcesJar()
15+
16+
javadoc {
17+
failOnError = false
18+
}
19+
1520
jar {
1621
from(rootProject.file("LICENSE")) {
1722
rename { "${it}_${mod_name}" }

0 commit comments

Comments
 (0)