Skip to content

Merge pull request #11 from Kurocado-Studio/canary #7

Merge pull request #11 from Kurocado-Studio/canary

Merge pull request #11 from Kurocado-Studio/canary #7

name: Build, Test, and Deploy Documentation
on:
push:
branches: ['main']
pull_request:
branches: ['main']
workflow_dispatch:
permissions:
contents: write
pages: write
id-token: write
env:
INSTANCE: 'Writerside/dcs' # Name of the module (adjust for your project)
ARTIFACT: 'webHelpDCS2-all.zip' # Name of the artifact to be generated
DOCKER_VERSION: '242.21870' # Specific Docker version
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }} # Ensure access to private repo
fetch-depth: 0
- name: Build docs using Writerside Docker builder
uses: JetBrains/writerside-github-action@v4
with:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
docker-version: ${{ env.DOCKER_VERSION }}
- name: Save artifact with build results
uses: actions/upload-artifact@v4
with:
name: docs
path: |
artifacts/${{ env.ARTIFACT }} # Artifact inside the artifacts folder
artifacts/report.json
retention-days: 7
- name: Unzip artifact
run: |
unzip -O UTF-8 -qq artifacts/${{ env.ARTIFACT }} -d dir
- name: Configure GitHub Pages
uses: actions/configure-pages@v4
- name: Upload artifact to GitHub Pages
uses: actions/upload-pages-artifact@v3
with:
path: dir
- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
test:
runs-on: ubuntu-latest
needs: build-and-deploy
steps:
- name: Download artifact
uses: actions/download-artifact@v4
with:
name: docs
path: artifacts
- name: Test documentation using Writerside Checker
uses: JetBrains/writerside-checker-action@v1
with:
instance: ${{ env.INSTANCE }}