Skip to content

Merge pull request #143 from codesquadnest/dependabot/pip/mkdocs-mate… #46

Merge pull request #143 from codesquadnest/dependabot/pip/mkdocs-mate…

Merge pull request #143 from codesquadnest/dependabot/pip/mkdocs-mate… #46

Workflow file for this run

---
name: Deploy Documentation
on:
push:
branches: [main]
permissions:
contents: write
jobs:
deploy-documentation:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Install poetry
run: pipx install poetry>=1.8.3
# set-up python with cache
- name: Setup Python 3.10
uses: actions/setup-python@v5
with:
python-version: "3.10"
cache: "poetry"
# install requirements (including dev dependencies)
- name: Install requirements
run: poetry install --only docs
# build & deploy docs
- name: Build docs
run: |
set -o pipefail
poetry run mkdocs gh-deploy -m "docs: update documentation" -v --force