diff options
Diffstat (limited to '.github/workflows/build-docs.yml')
| -rw-r--r-- | .github/workflows/build-docs.yml | 128 |
1 files changed, 64 insertions, 64 deletions
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 84f9cb0..a129e0c 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -1,80 +1,80 @@ name: Build documentation
on:
- push:
- branches: ["main"]
- workflow_dispatch:
+ push:
+ branches: [ "main" ]
+ workflow_dispatch:
permissions:
- id-token: write
- pages: write
+ id-token: write
+ pages: write
env:
- INSTANCE: 'Writerside/md'
- ARTIFACT: 'webHelpMD2-all.zip'
- DOCKER_VERSION: '241.18775'
+ INSTANCE: 'Writerside/md'
+ ARTIFACT: 'webHelpMD2-all.zip'
+ DOCKER_VERSION: '241.18775'
jobs:
- build:
- runs-on: ubuntu-latest
- steps:
- - name: Checkout repository
- uses: actions/checkout@v4
- with:
- fetch-depth: 0
+ 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 }}
+ - 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
- test:
- needs: build
- runs-on: ubuntu-latest
- steps:
- - name: Download artifacts
- uses: actions/download-artifact@v4
- with:
- name: docs
- path: artifacts
+ - name: Save artifact with build results
+ uses: actions/upload-artifact@v4
+ with:
+ name: docs
+ path: |
+ artifacts/${{ env.ARTIFACT }}
+ artifacts/report.json
+ retention-days: 7
+ 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: ${{ env.INSTANCE }}
- deploy:
- environment:
- name: github-pages
- url: ${{ steps.deployment.outputs.page_url }}
- needs: [build, test]
- runs-on: ubuntu-latest
- steps:
- - name: Download artifacts
- uses: actions/download-artifact@v4
- with:
- name: docs
+ - name: Test documentation
+ uses: JetBrains/writerside-checker-action@v1
+ with:
+ instance: ${{ env.INSTANCE }}
+ deploy:
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ needs: [ build, test ]
+ runs-on: ubuntu-latest
+ steps:
+ - name: Download artifacts
+ uses: actions/download-artifact@v4
+ with:
+ name: docs
- - name: Unzip artifact
- run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir
+ - name: Unzip artifact
+ run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir
- - name: Setup Pages
- uses: actions/configure-pages@v4
+ - name: Setup Pages
+ uses: actions/configure-pages@v4
- - name: Package and upload Pages artifact
- uses: actions/upload-pages-artifact@v3
- with:
- path: dir
+ - 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
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4
|