diff options
Diffstat (limited to 'json4cpp/.github/workflows/publish_documentation.yml')
| -rw-r--r-- | json4cpp/.github/workflows/publish_documentation.yml | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/json4cpp/.github/workflows/publish_documentation.yml b/json4cpp/.github/workflows/publish_documentation.yml new file mode 100644 index 0000000000..1703726be6 --- /dev/null +++ b/json4cpp/.github/workflows/publish_documentation.yml @@ -0,0 +1,46 @@ +name: Publish documentation + +# publish the documentation on every merge to develop branch +on: + push: + branches: + - develop + paths: + - docs/mkdocs/** + - docs/examples/** + workflow_dispatch: + +# we don't want to have concurrent jobs, and we don't want to cancel running jobs to avoid broken publications +concurrency: + group: documentation + cancel-in-progress: false + +permissions: + contents: read + +jobs: + publish_documentation: + permissions: + contents: write + + if: github.repository == 'nlohmann/json' + runs-on: ubuntu-22.04 + steps: + - name: Harden Runner + uses: step-security/harden-runner@fa2e9d605c4eeb9fcad4c99c224cee0c6c7f3594 # v2.16.0 + with: + egress-policy: audit + + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + + - name: Install virtual environment + run: make install_venv -C docs/mkdocs + + - name: Build documentation + run: make build -C docs/mkdocs + + - name: Deploy documentation + uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/mkdocs/site |