Skip to content

Merge pull request #1658 from GhostWriters/dependabot/pip/mkdocs-mini… #669

Merge pull request #1658 from GhostWriters/dependabot/pip/mkdocs-mini…

Merge pull request #1658 from GhostWriters/dependabot/pip/mkdocs-mini… #669

Workflow file for this run

name: Build mkdocs and deploy to GitHub Pages
on: [push, pull_request]
jobs:
build:
name: Build docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3.5.3
- uses: actions/setup-python@v4.7.0
with:
python-version: 3.x
- uses: actions/cache@v3.3.1
with:
key: ${{ github.ref }}
path: .cache
- run: pip install -r docs/requirements.txt
- run: |
cp README.md docs/index.md
- run: mkdocs build
deploy:
if: github.event_name == 'push' && contains(fromJson('["refs/heads/master", "refs/heads/main"]'), github.ref)
needs: build
name: Deploy docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3.5.3
with:
fetch-depth: '0'
- uses: actions/setup-python@v4.7.0
with:
python-version: 3.x
- uses: actions/cache@v3.3.1
with:
key: ${{ github.ref }}
path: .cache
- run: pip install -r docs/requirements.txt
- run: |
cp README.md docs/index.md
- run: mkdocs gh-deploy --force