From 13477afb3f37849a0778e8b7699fafb837599e03 Mon Sep 17 00:00:00 2001 From: Tapeline Date: Sat, 1 Feb 2025 16:08:44 +0500 Subject: [PATCH] Add docs workflow --- .github/workflows/docs.yml | 100 +++++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..17aab8d --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,100 @@ +name: Build documentation + +on: + push: + branches: ["master"] + workflow_dispatch: + +permissions: + contents: read + id-token: write + +env: + INSTANCE: 'Writerside/docs' + DOCKER_VERSION: '243.22562' + +jobs: + build: + runs-on: ubuntu-latest + outputs: + artifact: ${{ steps.define-ids.outputs.artifact }} + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Define instance id and artifacts + id: define-ids + run: | + INSTANCE=${INSTANCE#*/} + INSTANCE_ID_UPPER=$(echo "$INSTANCE" | tr '[:lower:]' '[:upper:]') + ARTIFACT="webHelp${INSTANCE_ID_UPPER}2-all.zip" + + # Print the values + echo "INSTANCE_ID_UPPER: $INSTANCE_ID_UPPER" + echo "ARTIFACT: $ARTIFACT" + + # Set the environment variables and outputs + echo "INSTANCE_ID_UPPER=$INSTANCE_ID_UPPER" >> $GITHUB_ENV + echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV + echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT + + - name: Build docs using Writerside Docker builder + uses: JetBrains/writerside-github-action@v4 + with: + instance: ${{ env.INSTANCE }} + docker-version: ${{ env.DOCKER_VERSION }} + + - name: Save artifact with build results + uses: actions/upload-artifact@v4 + with: + name: docs + path: | + artifacts/${{ steps.define-ids.outputs.artifact }} + artifacts/report.json + retention-days: 1 + + + + test: + needs: build + runs-on: ubuntu-latest + steps: + - name: Download artifacts + uses: actions/download-artifact@v4 + with: + name: docs + path: artifacts + + - name: Test documentation + uses: JetBrains/writerside-checker-action@v1 + with: + instance: ${{ env.INSTANCE }} + + + + deploy: + needs: [build, test] + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + with: + ref: gh-pages + + - name: Download artifacts + uses: actions/download-artifact@v4 + with: + name: docs + path: artifacts + + - name: Unzip artifact + run: unzip -O UTF-8 -qq "docs/${{ needs.build.outputs.artifact }}" -d dir + + - name: Commit to gh-pages + uses: stefanzweifel/git-auto-commit-action@v5 + with: + commit_message: Automated Docs Change + branch: gh-pages