Skip to content

Deploy multi-module dokka to GitHub Pages #6

Deploy multi-module dokka to GitHub Pages

Deploy multi-module dokka to GitHub Pages #6

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Deploy multi-module dokka to GitHub Pages
on:
# Runs on pushes targeting the default branch
# Pattern matched against refs/tags
push:
tags:
- '[0-9]+.[0-9]+.[0-9]+'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up JDK 17
uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'temurin'
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v3.1.0
with:
cache-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }}
cache-read-only: true
- name: Build multi-module GH pages
run: ./gradlew dokkaHtmlMultiModule
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: 'dokka/documentation'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1