mirror of
https://github.com/maxdorninger/MediaManager.git
synced 2026-02-20 07:59:50 -05:00
108 lines
3.0 KiB
YAML
108 lines
3.0 KiB
YAML
name: Build documentation
|
|
|
|
on:
|
|
push:
|
|
branches: [ "master" ]
|
|
paths:
|
|
- 'Writerside/**'
|
|
- '.github/workflows/build-docs.yml'
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
id-token: write
|
|
pages: write
|
|
|
|
env:
|
|
INSTANCE: 'Writerside/mm'
|
|
DOCKER_VERSION: '2025.04.8412'
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
algolia_artifact: ${{ steps.define-ids.outputs.algolia_artifact }}
|
|
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"
|
|
ALGOLIA_ARTIFACT="algolia-indexes-${INSTANCE_ID_UPPER}.zip"
|
|
|
|
# Print the values
|
|
echo "INSTANCE_ID_UPPER: $INSTANCE_ID_UPPER"
|
|
echo "ARTIFACT: $ARTIFACT"
|
|
echo "ALGOLIA_ARTIFACT: $ALGOLIA_ARTIFACT"
|
|
|
|
# Set the environment variables and outputs
|
|
echo "INSTANCE_ID_UPPER=$INSTANCE_ID_UPPER" >> $GITHUB_ENV
|
|
echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV
|
|
echo "ALGOLIA_ARTIFACT=$ALGOLIA_ARTIFACT" >> $GITHUB_ENV
|
|
echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT
|
|
echo "algolia_artifact=$ALGOLIA_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
|
|
artifacts/${{ steps.define-ids.outputs.algolia_artifact }}
|
|
retention-days: 7
|
|
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:
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
needs: [ build, test ]
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Download artifacts
|
|
uses: actions/download-artifact@v4
|
|
with:
|
|
name: docs
|
|
path: artifacts
|
|
|
|
- name: Unzip artifact
|
|
run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.artifact }}" -d dir
|
|
|
|
- name: Setup Pages
|
|
uses: actions/configure-pages@v4
|
|
|
|
- name: Package and upload Pages artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: dir
|
|
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|