dev: sparce-checkout to optomise book publish workflow #194
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: Publish Book | |
on: | |
# Manually trigger workflow | |
workflow_dispatch: | |
# Run work flow conditional on linter workflow success | |
workflow_run: | |
workflows: | |
- "MegaLinter" | |
paths: | |
- "docs/**" | |
- "includes/**" | |
- "overrides/**" | |
- "mkdocs.yaml" | |
branches: | |
- main | |
types: | |
- completed | |
permissions: | |
contents: write | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout Code | |
- uses: actions/checkout@v4 | |
with: | |
token: "${{ secrets.PAT || secrets.GITHUB_TOKEN }}" | |
fetch-depth: 0 # fetch all history, only checkout specific directories | |
sparse-checkout: | | |
docs | |
overrides | |
- run: echo "🐙 ${{ github.repository }} repository sparse-checkout to the CI runner." | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: 3.x | |
- uses: actions/cache@v3 | |
with: | |
key: ${{ github.ref }} | |
path: .cache | |
- run: pip install mkdocs-material mkdocs-callouts mkdocs-glightbox mkdocs-git-revision-date-localized-plugin mkdocs-redirects pillow cairosvg | |
- run: mkdocs gh-deploy --force |