Skip to content
docs

Automatically publish docs using GitHub workflow #1

Sign in to view logs

Automatically publish docs using GitHub workflow

Automatically publish docs using GitHub workflow #1

Workflow file for this run

.github/workflows/docs.yml at 6b0bdee
# This workflow generates and deploys the codebase docs using mkdocs to the gh-pages branch.
# The docs can then be viewed at https://digitalcommons.github.io/mykomap-monolith/.
name: docs
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
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-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force