|
| 1 | +name: Check documentation build for PR |
| 2 | + |
| 3 | +on: |
| 4 | + pull_request: |
| 5 | + |
| 6 | +permissions: |
| 7 | + contents: read |
| 8 | + |
| 9 | +env: |
| 10 | + INSTANCE: Writerside/ccs |
| 11 | + ARTIFACT: webHelpCCS2-all.zip |
| 12 | + DOCKER_VERSION: 2025.03.8312 |
| 13 | + |
| 14 | +jobs: |
| 15 | + build: |
| 16 | + runs-on: ubuntu-latest |
| 17 | + outputs: |
| 18 | + artifact: ${{ steps.define-ids.outputs.artifact }} |
| 19 | + algolia_artifact: ${{ steps.define-ids.outputs.algolia_artifact }} |
| 20 | + steps: |
| 21 | + - name: Checkout repository |
| 22 | + uses: actions/checkout@v4 |
| 23 | + with: |
| 24 | + fetch-depth: 0 |
| 25 | + |
| 26 | + - name: Define instance id and artifacts |
| 27 | + id: define-ids |
| 28 | + run: | |
| 29 | + INSTANCE=${INSTANCE#*/} |
| 30 | + INSTANCE_ID_UPPER=$(echo "$INSTANCE" | tr '[:lower:]' '[:upper:]') |
| 31 | + ARTIFACT="webHelp${INSTANCE_ID_UPPER}2-all.zip" |
| 32 | + ALGOLIA_ARTIFACT="algolia-indexes-${INSTANCE_ID_UPPER}.zip" |
| 33 | +
|
| 34 | + echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT |
| 35 | + echo "algolia_artifact=$ALGOLIA_ARTIFACT" >> $GITHUB_OUTPUT |
| 36 | + echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV |
| 37 | + echo "ALGOLIA_ARTIFACT=$ALGOLIA_ARTIFACT" >> $GITHUB_ENV |
| 38 | +
|
| 39 | + - name: Build docs using Writerside Docker builder |
| 40 | + uses: JetBrains/writerside-github-action@v4 |
| 41 | + with: |
| 42 | + instance: ${{ env.INSTANCE }} |
| 43 | + artifact: ${{ env.ARTIFACT }} |
| 44 | + docker-version: ${{ env.DOCKER_VERSION }} |
| 45 | + |
| 46 | + - name: Save artifact with build results |
| 47 | + uses: actions/upload-artifact@v4 |
| 48 | + with: |
| 49 | + name: docs |
| 50 | + path: | |
| 51 | + artifacts/${{ env.ARTIFACT }} |
| 52 | + artifacts/report.json |
| 53 | + artifacts/${{ env.ALGOLIA_ARTIFACT }} |
| 54 | + retention-days: 7 |
| 55 | + |
| 56 | + test: |
| 57 | + needs: build |
| 58 | + runs-on: ubuntu-latest |
| 59 | + steps: |
| 60 | + - name: Download artifacts |
| 61 | + uses: actions/download-artifact@v4 |
| 62 | + with: |
| 63 | + name: docs |
| 64 | + path: artifacts |
| 65 | + |
| 66 | + - name: Test documentation |
| 67 | + uses: JetBrains/writerside-checker-action@v1 |
| 68 | + with: |
| 69 | + instance: ${{ env.INSTANCE }} |
0 commit comments