chore: update docs #10
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Build documentation | |
| on: | |
| push: | |
| branches: ["**"] | |
| paths: | |
| - .github/workflows/writerside.yml | |
| - Writerside/** | |
| workflow_dispatch: | |
| permissions: { id-token: write, pages: write } | |
| env: | |
| # Name of module and id separated by a slash | |
| INSTANCE: "Writerside/md" | |
| # Replace HI with the ID of the instance in capital letters | |
| ARTIFACT: "webHelpMD2-all.zip" | |
| # Writerside docker image version | |
| DOCKER_VERSION: "241.15989" | |
| # Add the variable below to upload Algolia indexes | |
| # Replace HI with the ID of the instance in capital letters | |
| ALGOLIA_ARTIFACT: algolia-indexes-MD.zip | |
| ALGOLIA_APP_ID: GF9WWVY2E3 | |
| ALGOLIA_INDEX_NAME: memospot-docs | |
| ALGOLIA_KEY: ${{ secrets.ALGOLIA_KEY }} | |
| CONFIG_JSON_PRODUCT: md | |
| CONFIG_JSON_VERSION: "1.0" | |
| concurrency: | |
| cancel-in-progress: true | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - if: ${{ env.ALGOLIA_KEY == '' }} | |
| name: Fail job if Algolia Key is not set in secrets | |
| run: echo -e '\033[0;31m ALGOLIA_KEY not set!\033[0m' && exit 1 | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: { fetch-depth: 0 } | |
| - 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@v4 | |
| with: | |
| name: docs | |
| path: | | |
| artifacts/report.json | |
| artifacts/${{ env.ARTIFACT }} | |
| artifacts/${{ env.ALGOLIA_ARTIFACT }} | |
| retention-days: 7 | |
| # Add the job below if you want to fail the build when documentation contains errors | |
| test: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| strategy: { fail-fast: false } | |
| steps: | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v4 | |
| with: { name: docs, path: artifacts } | |
| - name: Test documentation | |
| uses: JetBrains/writerside-checker-action@v1 | |
| continue-on-error: true | |
| with: { instance: "${{ env.INSTANCE }}" } | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Download artifact | |
| 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@v5 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: { path: dir } | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |
| publish-indexes: | |
| needs: [build, deploy] | |
| runs-on: ubuntu-latest | |
| container: | |
| image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3 | |
| steps: | |
| - name: Download artifact | |
| uses: actions/download-artifact@v4 | |
| with: { name: docs } | |
| - 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_ID}}' \ | |
| --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 |