-
Notifications
You must be signed in to change notification settings - Fork 358
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test auto-deployment of documentation
- Loading branch information
1 parent
731d17d
commit f02ff42
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: deploy-docs | ||
on: | ||
push: | ||
branches: | ||
# triggers on new commits / merged PRs to main | ||
- main | ||
- docs-test | ||
permissions: | ||
contents: write | ||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Configure Git Credentials | ||
# credentials of GitHub's public bot, so that commits 'belonged' to bot | ||
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.12 | ||
# - 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- | ||
## original deploy instruction has --force | ||
# - run: mkdocs gh-deploy --force | ||
- run: pip install hatch && hatch run docs:deploy |