Skip to content

Commit 045d896

Browse files
committed
ci(docs): comment docs deploy job
Signed-off-by: Patryk Kamiński <patryk.kaminski@intel.com>
1 parent d16ce1a commit 045d896

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,21 @@ jobs:
4949
- name: Build docs
5050
run: uv run --no-default-groups --extra doc properdocs build --strict
5151

52+
# Deploys with mike instead of actions/deploy-pages to keep versioned docs (one
53+
# directory per version on the gh-pages branch, with a version selector).
54+
# mike pushes to gh-pages, so this job needs contents: write.
5255
deploy-docs:
5356
name: Deploy docs
5457
if: github.ref == 'refs/heads/main'
5558
runs-on: ubuntu-latest
5659
needs: build-docs
5760
permissions:
5861
contents: write
62+
# The workflow-level group is per event and ref, so runs for different refs can
63+
# deploy at the same time, e.g. a release pushes main and a tag together. This
64+
# shared group queues all deploys, so two mike pushes to gh-pages never race,
65+
# and a running deploy is not cancelled by a queued one. A newer push to the
66+
# same ref still cancels the whole older run.
5967
concurrency:
6068
group: docs-deploy
6169
cancel-in-progress: false

0 commit comments

Comments
 (0)