Skip to content

docs(changelog): back-fill 74 undocumented changes before Monday's release - #1691

Open
kwit75 wants to merge 1 commit into
developfrom
chore/changelog-catch-up
Open

docs(changelog): back-fill 74 undocumented changes before Monday's release#1691
kwit75 wants to merge 1 commit into
developfrom
chore/changelog-catch-up

Conversation

@kwit75

@kwit75 kwit75 commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator

Rod asked this morning for an OSS release next Monday. As things stand it would ship with empty release notes.

What develop's CHANGELOG actually says

## [Unreleased]: since 2026-06-08     <- nothing under it
## [3.3.0] - 2026-06-08

Meanwhile develop is 68 commits ahead of stage, 58 of them feat/fix. Release notes are generated from this file, so all of that work was invisible to them.

Two gaps, one cause

1. The 3.4.0 cut never came back to develop. It happened on stage (#1654) and stayed there. develop does not know 3.4.0 exists.

That is the third instance of develop↔stage drift found this week — after RR_SES_REGION (saas #392) and the ALB ephemeral-storage block (saas #397). Three silent divergences in four days, each caught by accident. That is the release-flow problem in #1671 costing us real content, not just tidiness.

2. 74 changes have no entry anywhere. Reconstructed from the commit log, grouped Added / Fixed / Changed / Documentation / Internal.

I checked the overlap rather than assuming: of 76 PR references generated, 2 were already documented in stage's 3.4.0 (#1475, #1604). Both dropped, so nothing is stated twice.

No [3.4.0] section — deliberately

Rod cancelled that release this morning ("we decided not to release"), so no 3.4.0 was ever published. Adding a version header here would claim a release that does not exist and would put a date on notes nobody can install. Its content is folded into [Unreleased] instead, with a comment explaining why, and Monday's version bump cuts the whole block under whatever number we actually ship.

What this does not fix

Two things worth being straight about:

  • The entries are reconstructed from commit subjects after the fact. That is strictly worse than authors writing them at PR time — a commit subject says what changed, not why a user should care. Some of these read like changelog entries; some read like commit messages. They are honest but thin.
  • stage's 3.4.0 section referenced only 15 PRs for a release carrying far more, so that cut was already thin when it was made. The habit is the actual fix: a line under [Unreleased] in the PR that makes the change. Worth raising with Charlie since release ownership is his.

This makes Monday shippable. It does not make the process work.

Related: #1671, #1654.

…lease

Rod asked for an OSS release next Monday. As it stands it would have shipped
with empty release notes, which is the exact failure we thought was fixed.

develop's CHANGELOG reads:

    ## [Unreleased]: since 2026-06-08     <- nothing under it
    ## [3.3.0] - 2026-06-08

while develop is 68 commits ahead of stage, 58 of them feat/fix. Release notes
are generated from this file, so every one of those changes was invisible.

Two separate gaps, both from the same cause:

1. **The 3.4.0 cut never came back to develop.** It happened on `stage`
   (#1654) and stayed there, so develop does not know 3.4.0 exists. That is the
   third instance of develop<->stage drift found this week, after RR_SES_REGION
   and the ALB ephemeral-storage block in saas.

2. **74 changes have no entry anywhere.** Generated from the commit log and
   grouped Added / Fixed / Changed / Documentation / Internal. Checked the
   overlap against stage's 3.4.0 rather than assuming: 2 of 76 PR references
   were already documented there (#1475, #1604), and those two are dropped so
   nothing is stated twice.

**No [3.4.0] section is added, deliberately.** Rod cancelled that release this
morning, so no 3.4.0 was ever published; a version header here would claim one
that does not exist. Its notes are folded into [Unreleased] instead, and
Monday's version bump cuts the whole thing under whatever number we ship.

Worth naming: stage's 3.4.0 section referenced only 15 PRs for a release that
carried far more, so the cut was already thin when it was made. This does not
fix the process — the entries are reconstructed after the fact from commit
subjects, which is strictly worse than authors writing them at PR time. It
makes Monday shippable.

Related: #1671, server #1654.
@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Ignore keyword(s) in the title.

⛔ Ignored keywords (5)
  • [bot]
  • renovate
  • dependabot
  • release
  • chore(release)

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ed275467-9419-449f-b48f-6c15d9a89139

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/changelog-catch-up

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.

@github-actions github-actions Bot added the docs Documentation label Jul 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor
🤖 Internal: Discord sync marker

Auto-managed by the Discord notification workflow. Stores the linked Discord message ID and forum thread ID. Do not edit or delete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant