Skip to content

Update API docs

Update API docs #51

Workflow file for this run

name: Docs
run-name: Update API docs
on:
workflow_run:
workflows: [CI]
types: [completed]
branches: [master]
push:
branches: [master]
paths:
- ktreesitter/README.md
concurrency:
cancel-in-progress: true
group: ${{github.workflow}}-${{github.ref_name}}
permissions:
pages: write
id-token: write
jobs:
docs:
runs-on: ubuntu-latest
name: Publish docs on GitHub pages
if: >-
github.event_name == 'push' ||
github.event.workflow_run.conclusion == 'success'
environment:
name: github-pages
url: ${{steps.deployment.outputs.page_url}}
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
submodules: true
- name: Set up Java
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: 17
cache: gradle
cache-dependency-path: |
gradle/libs.versions.toml
gradle/wrapper/gradle-wrapper.properties
- name: Restore Kotlin/Native prebuilt
uses: actions/cache/restore@v4
with:
path: ${{runner.tool_cache}}/konan/kotlin-native-prebuilt-*
key: konan-${{runner.os}}-prebuilt-1.9
- name: Restore Kotlin/Native dependencies
uses: actions/cache/restore@v4
with:
path: ${{runner.tool_cache}}/konan/dependencies
key: konan-${{runner.os}}-dependencies
- name: Build documentation
run: ./gradlew --no-daemon generateFiles :ktreesitter:dokkaHtml
env:
KONAN_DATA_DIR: ${{runner.tool_cache}}/konan
- name: Upload pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: ktreesitter/build/dokka/html
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4