Auto-update README version samples during release bumps - #214
Conversation
Co-authored-by: felickz <1760475+felickz@users.noreply.github.com>
|
@copilot does this only update readme on full release, or on prerelease as well? |
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s release-bump configuration and README usage sample so that action-reference examples stay aligned with the project’s release tags when versions are bumped.
Changes:
- Updated the README GitHub Actions example to use the
v2.11.1tag instead of an unprefixed2.10.0. - Extended
.release.ymlmarkdown replacement patterns to also match{repository}@{version}(unprefixed refs) during automated bumps.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates an example workflow snippet to reference the v2.11.1 action tag. |
| .release.yml | Adds an additional pattern intended to bump unprefixed action refs in markdown. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 2/2 changed files
- Comments generated: 3
- Review effort level: Lite
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Only the full-release bump updates the README. These |
Co-authored-by: felickz <1760475+felickz@users.noreply.github.com>
Co-authored-by: felickz <1760475+felickz@users.noreply.github.com>
There was a problem hiding this comment.
Review details
Suppressed comments (1)
.release.yml:15
- The PR description says
.release.ymladds a replacement pattern for unprefixed action refs ({repository}@{version}), but the updated file only contains{repository}@v{version}and--branch "v{version}". Please update the PR description (or re-add the pattern if that was the intent) so release-bump behavior is accurately documented.
- "*.md"
- "docs/**/*.md"
patterns:
- "{repository}@v{version}"
- '--branch "v{version}"'
- Files reviewed: 8/8 changed files
- Comments generated: 0 new
- Review effort level: Lite
| paths: | ||
| - "*.md" | ||
| - "docs/*.md" | ||
| - "docs/**/*.md" |
Release bumps were updating only
@v{version}and--branch "v{version}"patterns in markdown, and only in top-leveldocs/*.mdfiles — leaving nested docs and a few other things stale. This change fixes bump coverage and cleans up the samples it touches.Release bump path coverage
.release.yml's docs location glob fromdocs/*.mdtodocs/**/*.md, so nested files likedocs/introduction/actions.mdare actually covered by future release bumps (previously silently skipped, which is why they were still pinned to@v2.7.0).patternslist itself is unchanged:{repository}@v{version}and--branch "v{version}"only. An earlier revision of this PR added an additional unprefixed pattern ({repository}@{version}), but that was removed indfdbddfafter review — this repo only publishesv-prefixed tags (e.g.v2.11.1), so an unprefixed replacement would have pointed docs at a non-existent action ref.README / docs sample alignment
@v2.11.1:README.md(was@2.10.0, unprefixed) and all three occurrences indocs/introduction/actions.md(was@v2.7.0).Typo fix
Advance Security→Advanced Securityeverywhere it appeared (README.md,action.yml,examples/workflows/*.yml).