Fix incorrect argument name in build-docs workflow #65
This file contains hidden or 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: ["master"] | |
| pull_request: | |
| branches: [ "master" ] | |
| workflow_dispatch: | |
| permissions: | |
| id-token: write | |
| pages: write | |
| env: | |
| INSTANCE: 'Writerside/rw' | |
| ARTIFACT: 'webHelpRW2-all.zip' | |
| DOCKER_VERSION: '241.15989' | |
| ALGOLIA_ARTIFACT: 'webHelpRW2-all.zip' | |
| ALGOLIA_APP_NAME: 'S1V9Y61PCC' | |
| ALGOLIA_INDEX_NAME: 'prod_WIKI' | |
| ALGOLIA_KEY: '${{ secrets.ALGOLIA_KEY }}' | |
| CONFIG_JSON_PRODUCT: 'rw' | |
| CONFIG_JSON_VERSION: '1.0' | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - 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: List artifacts directory (test step) | |
| run: ls -l | |
| - 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: List artifacts directory (deploy step) | |
| run: ls -l | |
| - name: Unzip artifact | |
| run: unzip -O UTF-8 -qq "${{ env.ARTIFACT }}" -d dir | |
| - name: List artifacts directory (deploy step) | |
| run: ls -l 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 | |
| publish-indexes: | |
| needs: [build, test, 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: List artifacts directory (publish step) | |
| run: ls -l | |
| - name: Unzip artifact | |
| run: | | |
| unzip -O UTF-8 -qq "${{ env.ALGOLIA_ARTIFACT }}" -d algolia-indexes | |
| - name: Check algolia-indexes directory | |
| run: | | |
| echo "Checking contents of algolia-indexes:" | |
| ls -l algolia-indexes || (echo "Directory 'algolia-indexes' does not exist or is empty!" && exit 1) | |
| - name: Publish to Algolia Index (Debug) | |
| run: | | |
| 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 |