Skip to content

Commit 63ebd5e

Browse files
committed
Add api generation workflow to CI
Signed-off-by: Stoyan Petrov <stoyan@petrov.ca>
1 parent 4e2f953 commit 63ebd5e

3 files changed

Lines changed: 96 additions & 1 deletion

File tree

.github/workflows/ci.yaml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,4 +176,13 @@ jobs:
176176
secrets:
177177
MEND_EMAIL: ${{ secrets.MEND_EMAIL }}
178178
MEND_USER_KEY: ${{ secrets.MEND_USER_KEY }}
179-
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
179+
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
180+
181+
# Run dokka
182+
generate-docs:
183+
name: Generate API docs
184+
uses: ./.github/workflows/generate-docs.yaml
185+
186+
publish-docs:
187+
name: Publish API docs
188+
uses: ./.github/workflows/publish-docs.yaml
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Generate API Docs
2+
3+
on:
4+
workflow_call:
5+
6+
permissions:
7+
contents: read
8+
pages: write
9+
id-token: write
10+
11+
concurrency:
12+
group: "pages"
13+
cancel-in-progress: true
14+
15+
jobs:
16+
build-docs:
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v4
22+
23+
- name: Set up Java
24+
uses: actions/setup-java@v4
25+
with:
26+
distribution: temurin
27+
java-version: 17
28+
29+
- name: Set up Gradle
30+
uses: gradle/actions/setup-gradle@v4
31+
32+
- name: Generate Dokka HTML
33+
run: ./gradlew clean dokkaGeneratePublicationHtml
34+
35+
- name: Verify docs output
36+
run: |
37+
test -f build/dokka/html/index.html
38+
ls -la build/dokka/html
39+
40+
- name: Configure Pages
41+
uses: actions/configure-pages@v5
42+
43+
- name: Upload Pages artifact
44+
uses: actions/upload-pages-artifact@v3
45+
with:
46+
path: build/dokka/html
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Publish Dokka Docs
2+
3+
on:
4+
workflow_call:
5+
6+
permissions:
7+
contents: read
8+
pages: write
9+
id-token: write
10+
11+
concurrency:
12+
group: pages
13+
cancel-in-progress: true
14+
15+
jobs:
16+
build:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
- uses: actions/setup-java@v4
21+
with:
22+
distribution: temurin
23+
java-version: 17
24+
- uses: gradle/actions/setup-gradle@v4
25+
- run: ./gradlew clean dokkaGeneratePublicationHtml
26+
- run: test -f build/dokka/html/index.html
27+
- uses: actions/upload-pages-artifact@v3
28+
with:
29+
path: build/dokka/html
30+
31+
deploy:
32+
needs: build
33+
runs-on: ubuntu-latest
34+
environment:
35+
name: github-pages
36+
url: ${{ steps.deployment.outputs.page_url }}
37+
steps:
38+
- uses: actions/configure-pages@v5
39+
- id: deployment
40+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)