Skip to content

fix(ci): unescape ${version%%.*} in post-release-docs-issue.yml heredoc - #828

Merged
github-actions[bot] merged 1 commit into
mainfrom
fix/issue-827-post-release-heredoc
May 14, 2026
Merged

fix(ci): unescape ${version%%.*} in post-release-docs-issue.yml heredoc#828
github-actions[bot] merged 1 commit into
mainfrom
fix/issue-827-post-release-heredoc

Conversation

@robotrocketscience

Copy link
Copy Markdown
Owner

Summary

Closes #827. One-char fix in .github/workflows/post-release-docs-issue.yml line 49 — drops the backslash before ${version%%.*} inside the unquoted heredoc so the major-version expansion fires instead of emitting literal ${version%%.*} text into the generated docs-sweep nag issue.

Surrounding ${version} on the same line and on line 50 is already unescaped; this commit removes the inconsistency.

Verification

$ bash -c 'version="3.1.0"; echo "CHANGELOG/v${version%%.*}.md"'
CHANGELOG/v3.md

For a release tagged v3.1.0, the post-release-docs issue body will now correctly read CHANGELOG/v3.md has a ## [3.1.0] section ... rather than CHANGELOG/v${version%%.*}.md.

Out of scope

The other two CodeRabbit findings on #811 (file=CHANGELOG.md annotation, regex-metachar dot escaping) — both noted as defensible / pedantic in #827's body.

Closes #827.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Sorry @robotrocketscience, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@coderabbitai

coderabbitai Bot commented May 14, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@robotrocketscience has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 58 minutes and 19 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 20295bac-57f8-44ef-836c-e13f0ce2dfa1

📥 Commits

Reviewing files that changed from the base of the PR and between 4339951 and 5f71d80.

📒 Files selected for processing (1)
  • .github/workflows/post-release-docs-issue.yml
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/issue-827-post-release-heredoc

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@robotrocketscience robotrocketscience added the attn:review Needs review (PR open, awaiting reviewer) label May 14, 2026
@robotrocketscience

Copy link
Copy Markdown
Owner Author

[claim:review:oppenheimer:2026-05-14T23:16:42Z]

@robotrocketscience robotrocketscience added the ready-to-merge Trigger merge-train: FF main to this PR's head label May 14, 2026
@robotrocketscience

Copy link
Copy Markdown
Owner Author

[release:review:oppenheimer:2026-05-14T23:18:25Z]

@github-actions

Copy link
Copy Markdown

merge-train: blocked

branch is not fast-forward on main (branch base 32aa894eea336af58cf9fb44972bd1c7b04bd0bc, current main ca0b09ce09e7c51239cb1e9d90405457eb9ee661). Rebase locally (git rebase github/main), force-push, and re-add the label.

The ready-to-merge label has been removed. Address the issue above and re-add the label when you're ready for another attempt.

@github-actions github-actions Bot removed the ready-to-merge Trigger merge-train: FF main to this PR's head label May 14, 2026
@robotrocketscience robotrocketscience added attn:merge-conflict PR branch needs rebase and removed attn:review Needs review (PR open, awaiting reviewer) labels May 14, 2026
…doc (#827)

The heredoc was unquoted (<<EOF), so the backslash before \${version%%.*}
suppressed expansion and emitted the literal string instead of the major-version
digit; removing the backslash makes it consistent with the unescaped \${version}
on the adjacent line.
@robotrocketscience
robotrocketscience force-pushed the fix/issue-827-post-release-heredoc branch from cca0cd3 to 5f71d80 Compare May 14, 2026 23:38
@robotrocketscience robotrocketscience added attn:review Needs review (PR open, awaiting reviewer) and removed attn:merge-conflict PR branch needs rebase labels May 14, 2026
@robotrocketscience

Copy link
Copy Markdown
Owner Author

[claim:review:oppenheimer:2026-05-14T23:39:30Z]

@robotrocketscience

Copy link
Copy Markdown
Owner Author

Approve-equivalent — single-character fix matches #827 acceptance exactly

One atomic commit (5f71d802, signed G). FF on github/main. Discretion grep clean.

Diff is one character on line 49: drops the \ before ${version%%.*}.

Bash semantics verified locally:

$ bash -c 'version="3.1.0"; echo "CHANGELOG/v${version%%.*}.md"'
CHANGELOG/v3.md

Matches the issue's "Intended" output exactly. Aligns with surrounding ${version} references in the same heredoc (lines 35-46, 49 right side, 50) which are already unescaped.

CI status: pytest 3.12 / 3.13, secrets-scan, history-scan, pattern-scan, label, typos, size-check (latest run), release-docs-check, commit-msg-prefix, pr-title-prefix, pr-body-issue-link all SUCCESS. analyze (python) (CodeQL) still in_progress at review time — merge-train will block on it cleanly.

No CHANGELOG entry needed — this is a CI/workflow fix to a generated nag issue body, not user-facing behavior.

Labeling ready-to-merge.

@robotrocketscience robotrocketscience added ready-to-merge Trigger merge-train: FF main to this PR's head and removed attn:review Needs review (PR open, awaiting reviewer) labels May 14, 2026
@robotrocketscience

Copy link
Copy Markdown
Owner Author

[release:review:oppenheimer:2026-05-14T23:40:41Z]

@github-actions
github-actions Bot merged commit 5f71d80 into main May 14, 2026
32 of 34 checks passed
@github-actions github-actions Bot removed the ready-to-merge Trigger merge-train: FF main to this PR's head label May 14, 2026
@github-actions

Copy link
Copy Markdown

merge-train: merged 5f71d80main via FF push.

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.

fix(ci): unescape ${version%%.*} in post-release-docs-issue.yml heredoc

1 participant