Skip to content

Commit

Permalink
ci(docs): mkdocs gh-deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
qin-yu committed Jan 10, 2025
1 parent 6c041ad commit fcc6520
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/build-and-publish-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Docs Build and Publish
on:
push:
branches:
- main
- qy/create-docs

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: |
conda activate plant-seg
pip install mkdocs-material \
mkdocs-git-revision-date-localized-plugin \
mkdocs-git-committers-plugin-2 \
mkdocs-autorefs \
mkdocstrings[python] \
markdown-exec
mkdocs gh-deploy --force
env:
MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.MKDOCS_GIT_COMMITTERS_APIKEY }}

0 comments on commit fcc6520

Please sign in to comment.