Skip to content

Commit

Permalink
Add workflow to publish Dokka HTML docs to project site (#383)
Browse files Browse the repository at this point in the history
Publish Dokka HTML docs to project site

See #382
  • Loading branch information
EdricChan03 authored Jan 11, 2024
1 parent 42c48b8 commit b79c559
Showing 1 changed file with 85 additions and 0 deletions.
85 changes: 85 additions & 0 deletions .github/workflows/github-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy to GitHub Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]

# 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 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

env:
JEKYLL_OUTPUT_DIR: ./dist
DOKKA_ARTIFACT_NAME: dokka-html

jobs:
api-docs:
name: Generate Dokka HTML docs
runs-on: macos-latest # For Kotlin/Native
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Configure JDK
uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: 11
- name: Generate Dokka HTML docs
run: ./gradlew :dokkaHtml
- name: Upload Dokka output
uses: actions/upload-artifact@v4
with:
name: ${{ env.DOKKA_ARTIFACT_NAME }}
path: build/dokka/html
if-no-files-found: error
# Build job
build:
name: Build Jekyll docs
runs-on: ubuntu-latest
needs: api-docs
steps:
# Workaround for https://github.com/actions/jekyll-build-pages/issues/101
- name: Create output directory
run: mkdir ${{ env.JEKYLL_OUTPUT_DIR }}
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./
destination: ${{ env.JEKYLL_OUTPUT_DIR }}
- name: Download Dokka artifact
uses: actions/download-artifact@v4
with:
name: ${{ env.DOKKA_ARTIFACT_NAME }}
path: ${{ env.JEKYLL_OUTPUT_DIR }}/api
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ${{ env.JEKYLL_OUTPUT_DIR }}

# Deployment job
deploy:
name: Deploy to GitHub Pages
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@v3

0 comments on commit b79c559

Please sign in to comment.