Updates for final release #17
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" ] | |
| # Gives the workflow permissions to clone the repo and create a page deployment | |
| permissions: | |
| id-token: write | |
| pages: write | |
| env: | |
| PRODUCT: docs/c | |
| DOC_ARTIFACT: webHelpC2-all.zip | |
| ALGOLIA_ARTIFACT: algolia-indexes-XX.zip | |
| jobs: | |
| build-dokka: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup JDK | |
| uses: actions/setup-java@v3 | |
| with: | |
| distribution: "temurin" | |
| java-version: "11" | |
| - name: Build Dokka | |
| uses: gradle/gradle-build-action@v2 | |
| with: | |
| arguments: dokkaHtmlMultiModule | |
| - name: Upload documentation | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: dokka | |
| path: docs/api | |
| retention-days: 7 | |
| build-writerside: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Build Writerside docs using Docker | |
| uses: JetBrains/writerside-github-action@v3 | |
| - name: Upload documentation | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: help | |
| path: artifacts/${{ env.DOC_ARTIFACT }} | |
| 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 | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| # Requires the build-job results | |
| needs: [build-writerside, build-dokka] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Download webhelp | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: help | |
| - name: Download dokka | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: dokka | |
| path: dir/api | |
| - name: Unzip artifact | |
| uses: montudor/action-zip@v1 | |
| with: | |
| args: unzip -qq ${{ env.DOC_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 |