fix(release): unblock CI on main + add RELEASING.md + bump-version fmt fix#12
Merged
Conversation
…blank line Three release-infra fixes that didn't make it into PR #11 before merge: 1. CHANGELOG.md formatting on main (vp fmt) — the 0.1.1 release commit left no blank line between the new dated heading and the previous one. 2. Add RELEASING.md — the maintainer guide referenced from CONTRIBUTING.md that was prepared but not in the merged squash. 3. scripts/bump-version.py now appends a trailing newline when inserting the dated heading, so future bumps produce vp fmt-clean output. Verified by simulating an `update_changelog("99.0.0")` call against the current CHANGELOG and re-running `vp check` — clean.
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three release-infra fixes that didn't make it into PR #11 before it was squash-merged:
1. CI on `main` is failing — `CHANGELOG.md` format
The `chore(release): cut 0.1.1` commit left no blank line between the new `## [0.1.1]` heading and the existing `## [0.1.0]` heading. `vp fmt` rejects this. One-line fix in this PR.
2. `RELEASING.md` was prepared but not merged
PR #11 was squash-merged before the doc commit landed. This PR re-adds it. CONTRIBUTING.md on main already points at it ("see RELEASING.md"), so without this the link is broken.
3. `scripts/bump-version.py` regression-fixed
Root cause of #1: when the script inserts the dated heading, it doesn't append a trailing blank line, so the new heading butts up against whatever follows. Fixed by appending `\n` to the replacement. Verified by simulating an `update_changelog("99.0.0")` call against the current CHANGELOG and re-running `vp check` — clean.
Note on the screenshot
The PyPI badges showing "package or version not found" is a shields.io CDN cache issue — not a publishing problem. `friday-agent-sdk 0.1.1` is live on PyPI:
```
$ curl -s https://pypi.org/pypi/friday-agent-sdk/json | jq '.info.version'
"0.1.1"
$ curl -s 'https://img.shields.io/pypi/v/friday-agent-sdk.svg?cb=now' | head -c 100
<svg ... aria-label="pypi: v0.1.1">
```
The badge will self-heal as shields.io's cache expires (~6 hours). To force a refresh, you can append a cache-bust query string to the badge URL in the README temporarily, or just wait.
Test plan