Merge pull request #207 from StrangeBeeCorp/DOC-228 #148
This file contains hidden or 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
--- | |
name: Deploy doc in production | |
on: | |
push: | |
branches: | |
- main | |
concurrency: deploy-doc | |
permissions: | |
contents: write | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Setup python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- name: Define cache_id | |
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | |
- name: Setup cache | |
uses: actions/cache@v4 | |
with: | |
key: mkdocs-material-${{ env.cache_id }} | |
path: .cache | |
restore-keys: | | |
mkdocs-material- | |
- name: Install python requirements.txt | |
run: pip install -r requirements.txt | |
- name: Build doc | |
run: mkdocs build | |
- name: Clone branch gh-pages | |
uses: actions/checkout@v4 | |
with: | |
ref: gh-pages | |
path: gh-pages # clone in $GITHUB_WORKSPACE/gh-pages/ | |
- name: Copy build results | |
run: | | |
rsync -av \ | |
--delete \ | |
--checksum \ | |
--exclude .git/ \ | |
--exclude pr-preview/ \ | |
site/ $GITHUB_WORKSPACE/gh-pages/ | |
- name: Commit and push | |
run: | | |
cd $GITHUB_WORKSPACE/gh-pages/ | |
git config user.name github-actions[bot] | |
git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
git add -A | |
git commit -m "Auto build/deploy docs from main branch" || exit 0 | |
git push --force origin gh-pages |