Updated CSM sources for template generation #235
Workflow file for this run
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 docs website | |
| on: | |
| pull_request: | |
| paths: | |
| - 'docs/pages/**' | |
| - '.github/workflows/**' | |
| workflow_dispatch: | |
| inputs: | |
| dokka_artifact_url: | |
| description: 'URL of Dokka artifact.' | |
| required: true | |
| dry_run: | |
| type: boolean | |
| description: "Dry run. If set to true, the action will not actually publish the pages, but will assemble the artifact." | |
| default: true | |
| required: true | |
| permissions: | |
| id-token: write | |
| pages: write | |
| env: | |
| INSTANCE: 'kotlinx-rpc/rpc' | |
| ARTIFACT: 'webHelpRPC2-all.zip' | |
| DOCKER_VERSION: '243.22562' | |
| ALGOLIA_ARTIFACT: 'algolia-indexes-RPC.zip' | |
| ALGOLIA_APP_NAME: 'MMA5Z3JT91' | |
| ALGOLIA_INDEX_NAME: 'prod_kotlin_rpc' | |
| ALGOLIA_KEY: '${{ secrets.ALGOLIA_KEY }}' | |
| CONFIG_JSON_PRODUCT: 'kotlinx-rpc' | |
| CONFIG_JSON_VERSION: '0.8.0' | |
| DOKKA_ARTIFACT: 'dokka.zip' | |
| ASSEMBLE_DIR: '__docs_assembled' | |
| ASSEMBLE_ARTIFACT: 'assembled.zip' | |
| 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 }} | |
| location: docs/pages/kotlinx-rpc/ | |
| - name: Save artifact with build results | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: kotlinx-rpc | |
| path: | | |
| artifacts/${{ env.ARTIFACT }} | |
| artifacts/report.json | |
| artifacts/${{ env.ALGOLIA_ARTIFACT }} | |
| retention-days: 7 | |
| test: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: kotlinx-rpc | |
| path: artifacts | |
| - name: Test documentation | |
| uses: JetBrains/writerside-checker-action@v1 | |
| with: | |
| instance: ${{ env.INSTANCE }} | |
| assemble: | |
| if: github.event_name == 'workflow_dispatch' | |
| needs: [ build, test ] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Download Writerside artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: kotlinx-rpc | |
| - name: Unzip Writerside artifacts | |
| run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }} | |
| - name: Download Dokka | |
| run: | | |
| if [ -z "${{ inputs.dokka_artifact_url }}" ]; then | |
| echo "'dokka_artifact_url' is not set" | |
| exit 1 | |
| fi | |
| curl -s -L ${{ inputs.dokka_artifact_url }} -o ${{ env.DOKKA_ARTIFACT }} | |
| if [ -z "$(ls | grep -x ${{ env.DOKKA_ARTIFACT }})" ]; then | |
| echo "Failed to download Dokka artifact: ${{ inputs.dokka_artifact_url }}" | |
| exit 1 | |
| fi | |
| - name: Unzip Dokka | |
| run: unzip -O UTF-8 -qq '${{ env.DOKKA_ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}/api | |
| - name: Update sitemap.xml | |
| run: chmod +x updateSitemap.sh && ./updateSitemap.sh ${{ env.ASSEMBLE_DIR }}/sitemap.xml ${{ env.ASSEMBLE_DIR }}/api | |
| - name: Save assembled artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: kotlinx-rpc-assembled | |
| path: | | |
| ${{ env.ASSEMBLE_DIR }} | |
| retention-days: 7 | |
| deploy: | |
| if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' && !inputs.dry_run | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: [ build, test, assemble ] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: kotlinx-rpc-assembled | |
| - name: Unzip artifact | |
| run: unzip -O UTF-8 -qq '${{ env.ASSEMBLE_ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }} | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Package and upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ${{ env.ASSEMBLE_DIR }} | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |
| publish-indexes: | |
| if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' && !inputs.dry_run | |
| needs: [ build, test, assemble, 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: kotlinx-rpc-assembled | |
| - 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 |