feat(ci): adds github actions workflow #4
Workflow file for this run
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: Writerside Documentation | ||
| on: | ||
| pull_request: | ||
| push: | ||
| branches: | ||
| - main | ||
| permissions: | ||
| contents: write | ||
| pages: write | ||
| id-token: write | ||
| env: | ||
| INSTANCE: 'Writerside/dcs' # Name of the module (adjust for your project) | ||
| ARTIFACT: 'webHelpDCS2-all.zip' # Name of the artifact to be generated | ||
| DOCKER_VERSION: '242.21870' # Specific Docker version | ||
| jobs: | ||
| build-and-deploy-docs: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} # Ensure access to private repo | ||
| fetch-depth: 0 | ||
| - name: Install Dependencies | ||
| uses: ./lib/actions/install-dependencies | ||
| - name: Run Lint Checks | ||
| uses: ./.github/actions/lint | ||
| - 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: Save artifact with build results | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: docs | ||
| path: | | ||
| artifacts/${{ env.ARTIFACT }} | ||
| artifacts/report.json | ||
| retention-days: 7 | ||
| - name: Unzip artifact | ||
| run: | | ||
| unzip -O UTF-8 -qq artifacts/${{ env.ARTIFACT }} -d dir | ||
| - name: Configure GitHub Pages | ||
| uses: actions/configure-pages@v4 | ||
| - name: Upload artifact to GitHub Pages | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: dir | ||
| - name: Deploy to GitHub Pages | ||
| uses: actions/deploy-pages@v4 | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| test-docs: | ||
| runs-on: ubuntu-latest | ||
| needs: build-and-deploy | ||
|
Check failure on line 71 in .github/workflows/ci.documentation.yml
|
||
| steps: | ||
| - name: Download artifact | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: docs | ||
| path: artifacts | ||
| - name: Test documentation using Writerside Checker | ||
| uses: JetBrains/writerside-checker-action@v1 | ||
| with: | ||
| instance: ${{ env.INSTANCE }} | ||
