diff options
| author | William Hergès <anhgelus.morhtuuzh@proton.me> | 2024-08-24 19:20:59 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-08-24 19:20:59 +0200 |
| commit | 5199d1ff598824a938b94997c3706296e34fa9aa (patch) | |
| tree | 3852f2b91761aa5a907dfc6feda175638fdddc52 /.github | |
| parent | dfbc5bbfd20a22edb2596b4d73248df57a4cce20 (diff) | |
| parent | 1e42af1d9ac1e0bc7d26c8323272fd6a32e3c400 (diff) | |
Merge pull request #8 from anhgelus/docs/online-wiki
[Docs] Online wiki
Diffstat (limited to '.github')
| -rw-r--r-- | .github/workflows/build-docs.yml | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 0000000..efd7cb3 --- /dev/null +++ b/.github/workflows/build-docs.yml @@ -0,0 +1,76 @@ +name: Build documentation
+
+on:
+ push:
+ branches: ["main"]
+ workflow_dispatch:
+
+env:
+ 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
+
+ - 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: 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: 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
|