Skip to content

Commit 660b062

Browse files
committed
👷 add GitHub Actions workflow for Dokka documentation generation and deployment
1 parent 03742a3 commit 660b062

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

.github/workflows/docs.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Docs
2+
3+
on:
4+
workflow_call:
5+
workflow_dispatch:
6+
permissions:
7+
contents: write
8+
concurrency:
9+
group: docs-${{ github.ref }}
10+
cancel-in-progress: true
11+
jobs:
12+
docs:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@v4
17+
- name: Validate Gradle Wrapper
18+
uses: gradle/actions/wrapper-validation@v4
19+
- name: Set up JDK 17
20+
uses: actions/setup-java@v4
21+
with:
22+
distribution: temurin
23+
java-version: '17'
24+
- name: Set up Gradle caching
25+
uses: gradle/actions/setup-gradle@v4
26+
- name: Build Dokka HTML (qs-kotlin)
27+
run: ./gradlew :qs-kotlin:dokkaHtml --no-daemon --stacktrace
28+
- name: Deploy to GitHub Pages
29+
uses: peaceiris/actions-gh-pages@v4
30+
with:
31+
github_token: ${{ secrets.GITHUB_TOKEN }}
32+
publish_branch: gh-pages
33+
publish_dir: qs-kotlin/build/dokka/html
34+
force_orphan: true

0 commit comments

Comments
 (0)