Fix #56: Deploy Dokka doc on GitHub pages #1
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Deploy Dokka docs with GitHub Pages | |
on: | |
# Runs on pushes targeting the default branch | |
push: | |
branches: | |
- trunk | |
- release/* | |
# Runs on pull requests targeting the default branch - just for testing for now | |
pull_request: | |
branches: | |
- trunk | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
# Build job | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Setup Pages | |
uses: actions/configure-pages@v4 | |
- name: Setup Java 17 | |
uses: actions/setup-java@v3 | |
with: | |
distribution: 'temurin' | |
java-version: '17' | |
- name: Setup Gradle to generate and submit dependency graphs | |
uses: gradle/gradle-build-action@v2 | |
with: | |
dependency-graph: generate-and-submit | |
- name: Generate dokka docs | |
run: ./gradlew :gravatar:dokkaHtml | |
- name: Move generated docs to branch directory | |
run: mv docs/dokka docs/${{ github.ref }} | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
# Deployment job | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |