chore: update api docs #36
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: Docs" | |
| on: | |
| push: | |
| branches: ["main"] | |
| workflow_dispatch: {} | |
| permissions: | |
| contents: read | |
| env: | |
| INSTANCE: 'Writerside/e' | |
| ARTIFACT: 'webHelpE2-all.zip' | |
| DOCKER_VERSION: '241.15989' | |
| ALGOLIA_ARTIFACT: 'algolia-indexes-E.zip' | |
| ALGOLIA_APP_NAME: 'GPZ3MWT2LQ' | |
| ALGOLIA_INDEX_NAME: 'dev_elide_docs' | |
| CONFIG_JSON_PRODUCT: 'E' | |
| CONFIG_JSON_VERSION: '1.0.0-alpha10' | |
| 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: Copy API docs to artifacts | |
| run: | | |
| cp -fv ./API/latest.tgz ./artifacts/apidocs.tgz | |
| - name: Save artifact with build results | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs | |
| path: | | |
| artifacts/${{ env.ARTIFACT }} | |
| artifacts/report.json | |
| artifacts/report.html | |
| artifacts/algolia-indexes-E.zip | |
| artifacts/apidocs.tgz | |
| 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 | |
| permissions: | |
| id-token: write | |
| pages: write | |
| 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@v5 | |
| - name: Create API docs layout | |
| run: | | |
| mkdir -p dir/api | |
| cp -fv apidocs.tgz dir/ | |
| cd dir | |
| tar --strip-components=1 -xzf apidocs.tgz | |
| rm -fv apidocs.tgz | |
| cd .. | |
| echo "API docs unpacked." | |
| tree -L 3 | |
| - 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 | |
| environment: | |
| name: algolia-index | |
| 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 | |
| env: | |
| ALGOLIA_KEY: ${{ secrets.ALGOLIA_KEY }} | |
| 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 |