docs/.github/workflows/deploy.yml at master · superposedinteractive/docs · GitHub

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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
name: Build documentation

on:
    # If specified, the workflow will be triggered automatically once you push to the `main` branch.
    # Replace `main` with your branch’s name
    push:
        branches: [ "master" ]
    # Specify to run a workflow manually from the Actions tab on GitHub
    workflow_dispatch:

# Gives the workflow permissions to clone the repo and create a page deployment
permissions:
    id-token: write
    pages: write

env:
    # Name of module and id separated by a slash
    INSTANCE: Writerside/sd
    # Replace HI with the ID of the instance in capital letters
    ARTIFACT: webHelpSD2-all.zip
    # Writerside docker image version
    DOCKER_VERSION: 232.10275
    # Add the variable below to upload Algolia indexes
    # Replace HI with the ID of the instance in capital letters
    ALGOLIA_ARTIFACT: algolia-indexes-SD.zip
    # Algolia application name
    ALGOLIA_APP_NAME: BND4FY212E
    # Algolia index name
    ALGOLIA_INDEX_NAME: "'superposed docs search'"
    # Algolia key
    ALGOLIA_KEY: ${{ secrets.ALGOLIA_KEY }}
    # Product name from config.json
    CONFIG_JSON_PRODUCT: SD
    # Version name from config.json
    CONFIG_JSON_VERSION: 1.0


jobs:
    build:
        runs-on: ubuntu-latest

        steps:
            -   name: Checkout repository
                uses: actions/checkout@v3

            -   name: Build Writerside docs using Docker
                uses: JetBrains/writerside-github-action@v4
                with:
                    instance: ${{ env.INSTANCE }}
                    artifact: ${{ env.ARTIFACT }}
                    docker-version: ${{ env.DOCKER_VERSION }}

            -   name: Upload documentation
                uses: actions/upload-artifact@v3
                with:
                    name: docs
                    path: |
                        artifacts/${{ env.ARTIFACT }}
                        artifacts/report.json
                    retention-days: 7

            # Add the step below to upload Algolia indexes
            -   name: Upload algolia-indexes
                uses: actions/upload-artifact@v3
                with:
                    name: algolia-indexes
                    path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
                    retention-days: 7

    # Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors
    test:
        # Requires build job results
        needs: build
        runs-on: ubuntu-latest

        steps:
            -   name: Download artifacts
                uses: actions/download-artifact@v1
                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 }}
        # Requires the build job results
        needs: test
        runs-on: ubuntu-latest
        steps:
            -   name: Download artifact
                uses: actions/download-artifact@v3
                with:
                    name: docs

            -   name: Unzip artifact
                run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir

            -   name: Setup Pages
                uses: actions/configure-pages@v2

            -   name: Upload artifact
                uses: actions/upload-pages-artifact@v1
                with:
                    path: dir

            -   name: Deploy to GitHub Pages
                id: deployment
                uses: actions/deploy-pages@v1

    publish-indexes:
        # Requires the build-job results
        needs: build
        runs-on: ubuntu-latest
        container:
            image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-2

        steps:
            -   name: Download artifact
                uses: actions/download-artifact@v3
                with:
                    name: algolia-indexes
            -   name: Unzip artifact
                run: |
                    unzip -O UTF-8 -qq ${{ env.ALGOLIA_ARTIFACT }} -d algolia-indexes
                    env "algolia-key=${{env.ALGOLIA_KEY}}" java -jar /opt/builder/help-publication-agent.jar \
                    update-index \
                    --application-name ${{env.ALGOLIA_APP_NAME}} \
                    --index-name ${{env.ALGOLIA_INDEX_NAME}} \
                    --product ${{env.CONFIG_JSON_PRODUCT}} \
                    --version ${{env.CONFIG_JSON_VERSION}} \
                    --index-directory algolia-indexes/ \
                    2>&1 | tee algolia-update-index-log.txt