Merge pull request #293 from DataDog/zenithar/doc_update_requirements #47
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: generate-docs | |
| on: | |
| workflow_dispatch: {} # allow manually triggering the workflow | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - "docs/**" | |
| - mkdocs.yml | |
| permissions: | |
| contents: read | |
| jobs: | |
| deploy: | |
| permissions: | |
| contents: write # for mkdocs gh-deploy to publish docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Harden Runner | |
| uses: step-security/harden-runner@8ca2b8b2ece13480cda6dacd3511b49857a23c09 | |
| with: | |
| egress-policy: block | |
| allowed-endpoints: > | |
| files.pythonhosted.org:443 | |
| github.com:443 | |
| pypi.org:443 | |
| - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab | |
| - uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 | |
| with: | |
| python-version: 3.x | |
| - run: pip install mkdocs-material mkdocs-awesome-pages-plugin markdown-captions | |
| - run: mkdocs gh-deploy --force |