docs: guide folks away from mistakes with results-dir with non-unique… #109
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: "[Docs] Publish docs site (via MkDocs)" | |
on: | |
workflow_dispatch: | |
push: | |
branches: [master] | |
paths: ['docs/**'] | |
permissions: # added using https://github.com/step-security/secure-workflows | |
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@v2 | |
with: | |
egress-policy: audit | |
# TODO: change to 'egress-policy: block' after auditing a number of runs and updating the allowed-endpoints option accordingly | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: 3.x | |
- run: pip install mkdocs-material | |
- run: mkdocs gh-deploy --force |