Skip to content

Commit

Permalink
Add docs workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
Tapeline committed Feb 1, 2025
1 parent c72e153 commit 13477af
Showing 1 changed file with 100 additions and 0 deletions.
100 changes: 100 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 13477af

Please sign in to comment.