Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: add API docs workflow #1110

Merged
merged 5 commits into from
Oct 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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