Skip to content

Commit 0310c56

Browse files
ci(docs): redeploy docs on release publish and manual dispatch (#326)
The mkdocs-material header version badge is baked into the static HTML at gh-deploy time from the GitHub Releases API. Since docs.yml only triggered on docs/ or mkdocs.yml changes, code-only releases (v2.11.0, v2.11.1) never rebuilt the site, leaving the badge frozen at v2.10.0. Add release:published and workflow_dispatch triggers so the docs (and badge) refresh on every release and on demand.
1 parent 886a79b commit 0310c56

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ on:
66
paths:
77
- 'docs/**'
88
- 'mkdocs.yml'
9+
# Rebuild when a release is published so the mkdocs-material version badge
10+
# (fetched at build time from the GitHub Releases API) stays current even
11+
# when a release touches only code/CHANGELOG and not docs/.
12+
release:
13+
types: [published]
14+
workflow_dispatch:
915

1016
permissions:
1117
contents: write

0 commit comments

Comments
 (0)