Skip to content

Commit 9060169

Browse files
committed
add manual docs publish workflow
1 parent fd44c66 commit 9060169

File tree

2 files changed

+28
-4
lines changed

2 files changed

+28
-4
lines changed

.github/workflows/release-automated.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,28 @@ on:
33
push:
44
branches: [ master, release, alpha, beta ]
55
jobs:
6+
publish-docs:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v2
10+
with:
11+
fetch-depth: 0
12+
- name: Set up JDK 11
13+
uses: actions/setup-java@v2
14+
with:
15+
java-version: '11'
16+
distribution: 'adopt'
17+
- name: Generate Javadoc
18+
run: ./gradlew javadocRelease
19+
- name: Deploy GitHub Pages
20+
uses: JamesIves/[email protected]
21+
with:
22+
token: ${{ secrets.GITHUB_TOKEN }}
23+
branch: gh-pages
24+
clean: true
25+
folder: build/docs/javadoc
26+
target-folder: api
27+
dry-run: true
628
release:
729
runs-on: ubuntu-latest
830
outputs:

.github/workflows/release.yml renamed to .github/workflows/release-manual-docs.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
name: release
2-
on:
3-
push:
4-
branches: [ master ]
1+
# Trigger this workflow only to manually publish API docs; this should only be used
2+
# in extraordinary circumstances as this is done automatically as part of the
3+
# automated release workflow.
4+
5+
name: release-manual-docs
6+
on: workflow_dispatch
57
jobs:
68
publish-docs:
79
runs-on: ubuntu-latest

0 commit comments

Comments
 (0)