Skip to content

Commit

Permalink
Automatically publish docs using GitHub workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
rogup committed Oct 11, 2024
1 parent 4ecf6a9 commit 6b0bdee
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 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

0 comments on commit 6b0bdee

Please sign in to comment.