Repository navigation
Keep the [Unreleased] changelog section off main - #10
Merged
Merged
Conversation
[Unreleased] now exists only on develop, and only while it has entries. The release-prep pull request renames it to the version heading without adding a new empty one, and the first later pull request with a changelog entry adds it back. The Release workflow's tag check refuses to publish a CHANGELOG.md that still has an [Unreleased] section. - Release.yml: the validate job fails on an [Unreleased] heading. - RELEASING.md, AGENTS.md, CONTRIBUTING.md, pull request template: add the section only with an entry, never during release prep, and merge nothing else into develop between release prep and the release merge. - CHANGELOG.md: remove the empty [Unreleased] section added by the 1.1.1 release prep.
There was a problem hiding this comment.
🟢 Approval recommended
The CI enforcement and documentation updates are consistent and low-risk, with only a minor documentation clarity suggestion noted.
Pull request overview
This PR updates the release process documentation and CI validation so that the CHANGELOG.md [Unreleased] section exists only on develop (and only when it has entries), and is prevented from reaching main and published releases.
Changes:
- Document that release-prep renames
[Unreleased]to the version heading without adding an empty replacement section. - Add a Release workflow validation that fails if
CHANGELOG.mdstill contains an[Unreleased]heading at tag time. - Remove the currently-empty
[Unreleased]section fromCHANGELOG.md(so release notes and PowerShell Gallery-linked changelog don’t include it).
File summaries
| File | Description |
|---|---|
| RELEASING.md | Documents the “no [Unreleased] on main” rule and updates release-prep steps accordingly. |
| CONTRIBUTING.md | Clarifies that contributors may need to add [Unreleased] after a release if it’s missing. |
| CHANGELOG.md | Removes the empty [Unreleased] section so released changelogs start at the latest version section. |
| AGENTS.md | Adds an explicit rule: only add [Unreleased] when adding an entry; never leave it in a release. |
| .github/workflows/Release.yml | Enforces “no [Unreleased] section” during release tag validation. |
| .github/pull_request_template.md | Updates checklist wording to reflect that [Unreleased] may need to be added when missing. |
Review details
- Files reviewed: 6/6 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+108
to
+112
| `[Unreleased]` exists only on `develop`, and only while it has entries. A release renames it to the version | ||
| heading, so right after a release there is none. The next pull request that adds an entry also adds the section at | ||
| the top, linked to a comparison from the last release: | ||
| `## [Unreleased](https://github.com/Sekers/ScriptMessage/compare/1.2.0...develop)`. The Release workflow refuses to | ||
| publish a tag whose `CHANGELOG.md` still has an `[Unreleased]` section. |
5 of 9 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
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.
Summary
[Unreleased]now exists only ondevelop, and only while it has entries. Release prep renames it to the versionheading without adding an empty replacement; the first later pull request with a changelog entry adds it back. The
Release workflow's tag check now refuses to publish a
CHANGELOG.mdthat still has an[Unreleased]section, sothe section never reaches
main, the GitHub release, or the changelog the PowerShell Gallery links to.This also removes the empty
[Unreleased]section that the 1.1.1 release prep (#8) added. It merges before the 1.1.1release pull request (#9), so 1.1.1 is the first release to go through the new check.
Release classification
Checklist
develop, ormainfor a hotfixCHANGELOG.mdhas an entry in the right section under[Unreleased](added if missing), or the change is not user-visible.\Tests\Invoke-Tests.ps1passes