Skip to content

fix(release): bump version badge in root README.md on every push to main#52

Merged
chefgs merged 2 commits intomainfrom
copilot/fix-version-bump-in-readme
Mar 21, 2026
Merged

fix(release): bump version badge in root README.md on every push to main#52
chefgs merged 2 commits intomainfrom
copilot/fix-version-bump-in-readme

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 21, 2026

release.yml was updating the version in cli/__version__.py, CHANGELOG.md, and hugo-docs/content/_index.md but skipping the version badge in the root README.md, leaving it permanently stale.

Changes

  • New step — "Update version badge in root README" applies the same sed substitution already used for the Hugo docs index:
    sed -i -E \
      "s|version-[0-9]+\.[0-9]+\.[0-9]+-blue|version-${NEW_VERSION}-blue|g" \
      README.md
  • add-pathsREADME.md added to the peter-evans/create-pull-request step so the file is committed in the automated version-bump PR
  • PR body — updated to reflect that README.md is now part of the automated bump

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

Copilot AI changed the title [WIP] Fix version bump in root README and Hugo docs fix(release): bump version badge in root README.md on every push to main Mar 21, 2026
Copilot AI requested a review from chefgs March 21, 2026 15:16
@chefgs chefgs marked this pull request as ready for review March 21, 2026 15:41
@chefgs
Copy link
Copy Markdown
Member

chefgs commented Mar 21, 2026

@copilot please review the changes

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 21, 2026

@copilot please review the changes

Here's a review of the changes in this PR (commit 19d0ad9):

What was broken: release.yml bumped the version in cli/__version__.py, CHANGELOG.md, and hugo-docs/content/_index.md on every push to main, but never touched README.md — leaving its version badge permanently stale.

What was changed:

  1. New step 4 — "Update version badge in root README"
    Uses the exact same sed substitution already in place for the Hugo docs:

    sed -i -E \
      "s|version-[0-9]+\.[0-9]+\.[0-9]+-blue|version-${NEW_VERSION}-blue|g" \
      README.md

    This targets only the shields.io badge URL pattern, so it's safe — it won't accidentally touch version strings elsewhere in the README.

  2. add-paths in create-pull-requestREADME.md added so the file is included in the automated version-bump commit/PR.

  3. PR body — updated to document that README.md is now part of each automated bump.

No other behaviour changed. The step ordering (1→2→3→4→5→6) is sequential and correct. The if: guard that prevents infinite loops remains untouched. The tag step still fires only when the PR is successfully created.

@chefgs chefgs merged commit f39ec90 into main Mar 21, 2026
9 checks passed
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.

2 participants