Skip to content

ci(github-action)!: Update actions/setup-python action to v5 (#912) #17

ci(github-action)!: Update actions/setup-python action to v5 (#912)

ci(github-action)!: Update actions/setup-python action to v5 (#912) #17

name: Deploy MkDocs with GitHub Pages dependencies preinstalled
on:
push:
branches:
- main
paths:
- ".github/workflows/publish-pages.yaml"
- ".github/mkdocs/**"
- "docs/**"
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install MkDocs
run: pip install mkdocs[i18n]
- name: Install requirements
run: pip install -r .github/mkdocs/requirements.txt
- name: Setup caching
uses: actions/cache@v3
with:
key: ${{ github.sha }}
path: .cache
- name: Build site (_site directory name is used for Jekyll compatiblity)
run: mkdocs build --config-file .github/mkdocs/mkdocs.yml --site-dir ./../../site
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./site
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v3