making some TODOs #30
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 & Deploy Docs | |
| on: | |
| push: | |
| # To trigger the workflow once you push to the `main` branch | |
| # Replace `main` with your branch’s name | |
| branches: ["main"] | |
| # Specify to run a workflow manually from the Actions tab on GitHub | |
| workflow_dispatch: | |
| permissions: | |
| id-token: write | |
| pages: write | |
| env: | |
| # Name of module and id separated by a slash | |
| INSTANCE: Writerside/fd | |
| # Replace XX with the ID of the instance in capital letters | |
| ARTIFACT: webHelpFD2-all.zip | |
| # Docker image version | |
| DOCKER_VERSION: 241.15989 | |
| jobs: | |
| build: | |
| if: contains(github.event.head_commit.message, '(docs)') == true | |
| runs-on: ubuntu-latest | |
| steps: | |
| - 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 artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs | |
| path: | | |
| artifacts/${{ env.ARTIFACT }} | |
| retention-days: 7 | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| # Requires build job results | |
| needs: build | |
| # Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
| permissions: | |
| pages: write # to deploy to Pages | |
| id-token: write # to verify the deployment originates from an appropriate source | |
| 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/[email protected] | |
| - name: Upload artifact | |
| uses: actions/[email protected] | |
| with: | |
| path: dir | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/[email protected] |