Skip to content

Normalize 2.1 CHANGELOG section ordering for release - #355

Merged
TheWitness merged 1 commit into
developfrom
chore/changelog-2.1-reorder
Nov 13, 2026
Merged

TheWitness merged 1 commit into
developfrom
chore/changelog-2.1-reorder

Conversation

@TheWitness

Copy link
Copy Markdown
Member

Description

Normalizes the --- 2.1 --- section of CHANGELOG.md to our release standard ahead of the 2.1 release. No code changes; INFO is already at version = 2.1 on develop.

Changes applied to the 2.1 section only (older sections untouched):

  • Dropped the two non-user-facing dev: entries.
  • Renamed the un-numbered bug: entries to issue:.
  • Reordered entries: security: block first (existing order preserved), then numbered issue#NNN: entries ascending by number, then the un-numbered issue: entries in alphabetical order.

No feature: or refactor: entries exist in the 2.1 section, so none were added or dropped there.

Related Issue

Release preparation for Weathermap 2.1 (changelog curation); no single issue.

Motivation and Context

Keeps the changelog consistent with the project's release conventions so the 2.1 notes are ordered predictably and omit internal-only dev: churn.

How Has This Been Tested?

Documentation/metadata only — no runtime code changed, so no test suite was run. Verified the rendered 2.1 section ordering and that the diff touches only the 2.1 entry block.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation repository accordingly.

Drop non-user-facing dev entries, rename bug entries to issue, and order the 2.1 section as security, numbered issues ascending, then alphabetical un-numbered issues.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings November 13, 2026 20:35
@sonarqubecloud

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues are reported for the release-note normalization in CHANGELOG.md.

No open issues 🎉

What changed in this PR

Normalizes the Weathermap 2.1 release notes in CHANGELOG.md without changing runtime code or older release sections.

Changes:

  • Removes two internal-only dev: entries.
  • Renames unnumbered bug: entries to issue:.
  • Preserves security entry order, sorts numbered issues ascending, and alphabetizes unnumbered issues.
File Description
CHANGELOG.md Standardizes entry labels and ordering in the 2.1 section for release.

Review effort: Balanced

@TheWitness
TheWitness merged commit 9ed422b into develop Nov 13, 2026
9 checks passed
@TheWitness
TheWitness deleted the chore/changelog-2.1-reorder branch November 13, 2026 23:40
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.

3 participants