Skip to content

Commit

Permalink
feat: add CI workflow for publishing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Fedir Zadniprovskyi authored and fedirz committed Jan 8, 2025
1 parent 40d0a9e commit 4a7c975
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/publish-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# https://www.mkdocs.org/user-guide/deploying-your-docs/
# https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions
name: publish-docs
on:
workflow_dispatch:
push:
branches:
- master
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/checkout@v4
- uses: astral-sh/setup-uv@v5
with:
version: "0.4.11"
enable-cache: true
- run: uv python install 3.12
- run: uv sync --extra dev
- 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: mkdocs gh-deploy --force

0 comments on commit 4a7c975

Please sign in to comment.