Skip to content

Commit

Permalink
ci: add API docs workflow (#1110)
Browse files Browse the repository at this point in the history
  • Loading branch information
mtrezza authored Oct 10, 2021
1 parent aa16bcf commit 62fb7eb
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/release-automated.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,28 @@ on:
push:
branches: [ master, release, alpha, beta ]
jobs:
publish-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Set up JDK 11
uses: actions/setup-java@v2
with:
java-version: '11'
distribution: 'adopt'
- name: Generate Javadoc
run: ./gradlew javadocRelease
- name: Deploy GitHub Pages
uses: JamesIves/github-pages-deploy-action@4.1.5
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
clean: true
folder: build/docs/javadoc
target-folder: api
dry-run: true
release:
runs-on: ubuntu-latest
outputs:
Expand Down
29 changes: 29 additions & 0 deletions .github/workflows/release-manual-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Trigger this workflow only to manually publish API docs; this should only be used
# in extraordinary circumstances as this is done automatically as part of the
# automated release workflow.

name: release-manual-docs
on: workflow_dispatch
jobs:
publish-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Set up JDK 11
uses: actions/setup-java@v2
with:
java-version: '11'
distribution: 'adopt'
- name: Generate Javadoc
run: ./gradlew javadocRelease
- name: Deploy GitHub Pages
uses: JamesIves/github-pages-deploy-action@4.1.5
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
clean: true
folder: build/docs/javadoc
target-folder: api
dry-run: true

0 comments on commit 62fb7eb

Please sign in to comment.