Merge pull request #601 from blacklanternsecurity/options_parsing_imp… #51
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 | |
on: | |
push: | |
branches: | |
- material-docs | |
- dev | |
permissions: | |
contents: write | |
jobs: | |
docgen: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.10" | |
- name: Install dependencies | |
run: | | |
pip install poetry | |
poetry install | |
- name: Generate docs | |
run: | | |
poetry run bbot/scripts/docs.py | |
- name: Commit docs | |
uses: EndBug/add-and-commit@v9 | |
with: | |
add: "*.md" | |
default_author: github_actions | |
message: "Refresh module docs" | |
deploy: | |
runs-on: ubuntu-latest | |
needs: docgen | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: 3.x | |
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | |
- uses: actions/cache@v3 | |
with: | |
key: mkdocs-material-${{ env.cache_id }} | |
path: .cache | |
restore-keys: | | |
mkdocs-material- | |
- run: pip install mkdocs-material mkdocs-extra-sass-plugin livereload | |
- run: mkdocs gh-deploy --force |