aboutsummaryrefslogtreecommitdiff
path: root/.github/workflows/gh-pages-deploy-mkdocs.yml
diff options
context:
space:
mode:
Diffstat (limited to '.github/workflows/gh-pages-deploy-mkdocs.yml')
-rw-r--r--.github/workflows/gh-pages-deploy-mkdocs.yml40
1 files changed, 40 insertions, 0 deletions
diff --git a/.github/workflows/gh-pages-deploy-mkdocs.yml b/.github/workflows/gh-pages-deploy-mkdocs.yml
new file mode 100644
index 00000000..b212f55b
--- /dev/null
+++ b/.github/workflows/gh-pages-deploy-mkdocs.yml
@@ -0,0 +1,40 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+ push:
+ branches:
+ - master
+ paths:
+ - 'mkdocs/**'
+ release:
+ types: [ published ]
+
+jobs:
+ docs:
+ if: github.repository == 'Kotlin/dokka'
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ with:
+ path: dokka
+ - uses: actions/setup-java@v3
+ with:
+ distribution: 'zulu'
+ java-version: 17
+ cache: 'maven'
+ - uses: gradle/gradle-build-action@v2
+ with:
+ gradle-home-cache-cleanup: true
+ - name: Get current dokka version
+ run: echo "DOKKA_VERSION=`./gradlew :properties | grep '^version:.*' | cut -d ' ' -f 2`" >> $GITHUB_ENV
+ working-directory: ./dokka
+ - name: Build docs
+ run: ./gradlew mkdocsBuild -Pdokka_version=$DOKKA_VERSION --info
+ working-directory: ./dokka
+ - name: Deploy
+ uses: peaceiris/actions-gh-pages@v3
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: ./dokka/mkdocs/build/mkdocs
+ keep_files: true
+ full_commit_message: Publish ${{ env.DOKKA_VERSION }} documentation