Skip to content

Commit cc89935

Browse files
committed
ci: deploy generated docs
1 parent f2d5d21 commit cc89935

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

.github/workflows/docs.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Docs
2+
on:
3+
push:
4+
branches:
5+
- master
6+
workflow_dispatch:
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
concurrency:
12+
group: "pages"
13+
cancel-in-progress: true
14+
jobs:
15+
deploy:
16+
environment:
17+
name: github-pages
18+
url: ${{ steps.deployment.outputs.page_url }}
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v3
22+
- name: Set up JDK
23+
uses: actions/setup-java@v3
24+
with:
25+
java-version-file: '.java-version'
26+
distribution: 'temurin'
27+
server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
28+
settings-path: ${{ github.workspace }} # location for the settings.xml file
29+
- name: Set up Gradle
30+
uses: gradle/actions/setup-gradle@v3
31+
with:
32+
cache-encryption-key: ${{ secrets.GradleEncryptionKey }} # openssl rand -base64 16
33+
validate-wrappers: true
34+
build-scan-publish: true
35+
build-scan-terms-of-use-url: "https://gradle.com/terms-of-service"
36+
build-scan-terms-of-use-agree: "yes"
37+
- name: Generate docs
38+
run: ./gradlew dokkaHtml
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
# Upload entire repository
43+
path: 'build/dokka/html'
44+
- name: Deploy to GitHub Pages
45+
id: deployment
46+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)