Add backend & frontend tests #26
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: Deploy Writerside Documentation | |
| on: | |
| # Trigger on pushes to main/development branch that affect documentation | |
| push: | |
| branches: [ development, main ] | |
| paths: | |
| - 'Writerside/**' | |
| - '.github/workflows/deploy-docs.yml' | |
| # Allow manual triggering | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| artifact: ${{ steps.define-ids.outputs.artifact }} | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Define instance id and artifacts | |
| id: define-ids | |
| run: | | |
| INSTANCE="Writerside/in" | |
| INSTANCE_ID="${INSTANCE#*/}" | |
| INSTANCE_ID_UPPER=$(echo "$INSTANCE_ID" | tr '[:lower:]' '[:upper:]') | |
| ARTIFACT="webHelp${INSTANCE_ID_UPPER}2-all.zip" | |
| # Print the values | |
| echo "INSTANCE_ID_UPPER: $INSTANCE_ID_UPPER" | |
| echo "ARTIFACT: $ARTIFACT" | |
| # Set the environment variables and outputs | |
| echo "INSTANCE_ID_UPPER=$INSTANCE_ID_UPPER" >> $GITHUB_ENV | |
| echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV | |
| echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT | |
| - name: Build Writerside docs using Docker | |
| uses: JetBrains/writerside-github-action@v4 | |
| with: | |
| instance: 'Writerside/in' | |
| docker-version: '243.22562' | |
| artifact: ${{ steps.define-ids.outputs.artifact }} | |
| - name: Upload documentation artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs | |
| path: artifacts/* | |
| retention-days: 7 | |
| # Add quality gate job that depends on the build job | |
| 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: 'Writerside/in' | |
| deploy: | |
| needs: [ build, test ] | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: docs | |
| path: artifacts | |
| - name: Unzip documentation | |
| run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.artifact }}" -d 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 |