Skip to content

fix(changelog): restore [Unreleased] heading on main + document the rule #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThomasK33 merged 1 commit into from
May 13, 2026
+27 −0
Merged

fix(changelog): restore [Unreleased] heading on main + document the rule #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Changelog

## [Unreleased]

## [v0.2.0] - 2026-05-13

### Added
Expand Down
25 changes: 25 additions & 0 deletions docs/RELEASE-PROCESS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,31 @@ communique generate "v<version>" --changelog --repo coder/agent-tty

and commits the resulting `CHANGELOG.md` update back to the release branch. When it pushes that bot commit, it dispatches the CI and skill-validation workflows for the updated release branch so protected-branch checks can run against the new head commit.

### `[Unreleased]` heading must stay on `main`

When preparing the release PR, **rename** the existing `## [Unreleased]` heading to `## [v<version>] - <date>` and **insert a fresh empty `## [Unreleased]` heading immediately above it** before pushing. Do not remove `[Unreleased]` outright.

Two workflows depend on this:

- `Release Changelog` (release-changelog.yml) keys off `## [v<version>]` to decide whether to run Communique on the release branch. Having `## [v<version>] - <date>` present makes the workflow skip its Communique pass and preserve the curated `[Unreleased]` content that you just renamed.
- `Update Unreleased Changelog` (update-unreleased-changelog.yml) runs on every push to `main` and calls `communique generate HEAD --changelog`, which requires `## [Unreleased]` or `## Unreleased` to exist. If the heading is missing on `main`, every post-release merge fails this workflow until the heading is restored.

So the right CHANGELOG.md state after the release-prep commit is roughly:

```markdown
# Changelog

## [Unreleased]

## [v<version>] - <date>

### Added

...
```

`release:prep --changelog ci` does not edit `CHANGELOG.md` for you, so this rename + insert must be done manually (or via `release:prep --changelog local`, which lets Communique handle both steps). After running `release:prep --changelog ci`, edit `CHANGELOG.md`, then `git add CHANGELOG.md && git commit --amend --no-edit` to fold the change into the same release-prep commit.

### Manual prep fallback

If the scripted prep path is blocked, use the manual fallback only from a clean, up-to-date `main` checkout. Stage `package-lock.json` only if your checkout still has one (post-PR #91 the repo is aube-only and the file is absent):
Expand Down
Loading