Skip to content

Auto-update README version samples during release bumps - #214

Merged
felickz merged 4 commits into
mainfrom
copilot/update-version-tag-readme
Aug 23, 2026
Merged

Auto-update README version samples during release bumps#214
felickz merged 4 commits into
mainfrom
copilot/update-version-tag-readme

Conversation

Copilot AI commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Release bumps were updating only @v{version} and --branch "v{version}" patterns in markdown, and only in top-level docs/*.md files — 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

    • Changed .release.yml's docs location glob from docs/*.md to docs/**/*.md, so nested files like docs/introduction/actions.md are actually covered by future release bumps (previously silently skipped, which is why they were still pinned to @v2.7.0).
    • The patterns list 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 in dfdbddf after review — this repo only publishes v-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

    • Updated stale action version refs to @v2.11.1: README.md (was @2.10.0, unprefixed) and all three occurrences in docs/introduction/actions.md (was @v2.7.0).
  • Typo fix

    • Corrected Advance SecurityAdvanced Security everywhere it appeared (README.md, action.yml, examples/workflows/*.yml).
# .release.yml (locations only; patterns unchanged from before this PR)
locations:
  - name: "Update Docs"
    paths:
      - "*.md"
      - "docs/**/*.md"
    patterns:
      - "{repository}@v{version}"
      - '--branch "v{version}"'

Co-authored-by: felickz <1760475+felickz@users.noreply.github.com>
@felickz

felickz commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

@copilot does this only update readme on full release, or on prerelease as well?

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.1 tag instead of an unprefixed 2.10.0.
  • Extended .release.yml markdown 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

Comment thread README.md Outdated
Comment thread .release.yml Outdated
Comment thread .release.yml
@github-actions

Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copilot AI commented Aug 19, 2026

Copy link
Copy Markdown
Contributor Author

@copilot does this only update readme on full release, or on prerelease as well?

Only the full-release bump updates the README. These .release.yml patterns are applied when the version is bumped, while the manual prerelease path only creates the prerelease tag/release and does not update .release.yml or README files.

Co-authored-by: felickz <1760475+felickz@users.noreply.github.com>
Copilot AI review requested due to automatic review settings August 19, 2026 05:18
@felickz
felickz marked this pull request as ready for review August 19, 2026 05:20
@felickz
felickz requested a review from a team as a code owner August 19, 2026 05:20
@felickz
felickz requested a review from adrienpessu August 19, 2026 05:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review details

  • Files reviewed: 8/8 changed files
  • Comments generated: 2
  • Review effort level: Lite

Comment thread .release.yml
Comment thread docs/introduction/actions.md
Co-authored-by: felickz <1760475+felickz@users.noreply.github.com>
Copilot AI review requested due to automatic review settings August 19, 2026 05:25

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review details

Suppressed comments (1)

.release.yml:15

  • The PR description says .release.yml adds 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

Copilot AI review requested due to automatic review settings August 23, 2026 00:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review details

  • Files reviewed: 8/8 changed files
  • Comments generated: 1
  • Review effort level: Lite

Comment thread .release.yml
paths:
- "*.md"
- "docs/*.md"
- "docs/**/*.md"
@felickz
felickz merged commit ecf202e into main Aug 23, 2026
18 checks passed
@felickz
felickz deleted the copilot/update-version-tag-readme branch August 23, 2026 00:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants