Skip to content

Commit

Permalink
ci(pages): add MkDocs deploy to GH Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
lgatellier authored May 8, 2024
1 parent 666c141 commit 917efe9
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/mkdocs-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: MkDocs GitHub Pages

on:
push:
branches: [main]

jobs:
build-deploy:
runs-on: ubuntu-latest
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
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
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: 3.10
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs
- name: Deploy docs site with MkDocs on GH Pages
- run: mkdocs gh-deploy --force

0 comments on commit 917efe9

Please sign in to comment.