Skip to content

Commit

Permalink
Merge pull request #5943 from janbrasna/upd/build-action
Browse files Browse the repository at this point in the history
Update docs workflow to build directly to deployment
  • Loading branch information
akatsoulas authored May 3, 2024
2 parents be21341 + d6570a3 commit f4f1f34
Showing 1 changed file with 33 additions and 9 deletions.
42 changes: 33 additions & 9 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,52 @@
name: Publish Docs in GitHub Pages

on:
workflow_dispatch: # allow manual runs
push:
branches:
- main
paths: # avoid extra builds
- docs/**
- mkdocs.yml
- .github/workflows/publish-docs.yml

permissions:
contents: write
contents: read
pages: write
id-token: write

concurrency:
group: github-pages
cancel-in-progress: false # skip any intermediate builds but let finish

jobs:
deploy:
build:
runs-on: ubuntu-latest
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
- uses: actions/setup-python@v4
- uses: actions/setup-python@v5
with:
python-version: 3.x
- id: pages
uses: actions/configure-pages@v4
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
- run: mkdocs build -d dist
- uses: actions/upload-pages-artifact@v3
with:
path: dist
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- id: deployment
uses: actions/deploy-pages@v4

0 comments on commit f4f1f34

Please sign in to comment.