aboutsummaryrefslogtreecommitdiff
path: root/.github/workflows/build-docs.yml
blob: a129e0cd28fc782ab07c98d6b903d01bc1aa7a98 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
name: Build documentation

on:
    push:
        branches: [ "main" ]
    workflow_dispatch:

permissions:
    id-token: write
    pages: write

env:
    INSTANCE: 'Writerside/md'
    ARTIFACT: 'webHelpMD2-all.zip'
    DOCKER_VERSION: '241.18775'

jobs:
    build:
        runs-on: ubuntu-latest
        steps:
            -   name: Checkout repository
                uses: actions/checkout@v4
                with:
                    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 }}
                        artifacts/report.json
                    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

            -   name: Unzip artifact
                run: unzip -O UTF-8 -qq '${{ env.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