index: refine list of features #95
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
name: MkDocs | |
on: [push, pull_request] | |
permissions: | |
contents: write | |
jobs: | |
mkdocs: | |
runs-on: ubuntu-latest | |
# prevent push event from triggering if it's part of a local PR, see | |
# https://github.com/orgs/community/discussions/57827#discussioncomment-6579237 | |
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Configure Git Credentials | |
run: | | |
git config user.name "${GITHUB_ACTOR}" | |
git config user.email "${GITHUB_ACTOR}@users.noreply.github.com" | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
- name: Install Python and dependencies | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.x' | |
cache: 'pip' | |
- run: pip install --upgrade pip wheel setuptools | |
- run: pip install -r requirements.txt | |
- 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- | |
- name: Build mkdocs | |
run: mkdocs build | |
- name: Deploy to GitHub Pages | |
if: github.ref == 'refs/heads/main' | |
run: mkdocs gh-deploy --force |