From 418d7909b7f76e7ae7b9f9c57500a2a6f34c2285 Mon Sep 17 00:00:00 2001 From: mani1232 Date: Sat, 29 Jun 2024 20:42:00 +0200 Subject: [PATCH] add docs --- .github/workflows/docs-ci.yml | 38 +++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/workflows/docs-ci.yml diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml new file mode 100644 index 0000000..01346a9 --- /dev/null +++ b/.github/workflows/docs-ci.yml @@ -0,0 +1,38 @@ +# This workflow will build and deploy docs to GitHub Pages whenever something is pushed to the main branch + +name: Docs + +on: + push: + branches: + - master + +permissions: + contents: write + +jobs: + docs: + name: Build and deploy docs + runs-on: ubuntu-latest + concurrency: # Allow one concurrent deployment + group: pages + cancel-in-progress: true + steps: + - uses: actions/checkout@v4 + - name: Set up JDK + uses: actions/setup-java@v4 + with: + distribution: zulu + java-version: 17 + - name: Set up Gradle + uses: gradle/actions/setup-gradle@v3 + - name: Build docs with Gradle + run: ./gradlew --stacktrace --info dokkaHtmlMultiModule + - name: Deploy docs to GitHub Pages + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: build/dokka/htmlMultiModule + branch: gh-pages + git-config-name: GitHub Actions + git-config-email: actions@github.com + commit-message: Update docs