Skip to content

Align release guidelines with script behavior for major/minor aggregation - #92

Merged
DutchmanNL merged 5 commits into
mainfrom
copilot/revive-stickers-pr
Feb 18, 2026
Merged

Align release guidelines with script behavior for major/minor aggregation#92
DutchmanNL merged 5 commits into
mainfrom
copilot/revive-stickers-pr

Conversation

Copilot AI commented Feb 18, 2026

Copy link
Copy Markdown
Contributor

Revive Stickers PR - Complete ✅

This PR successfully addresses all feedback from #90 with accurate implementation and improved terminology.

Problem Statement

PR #90 was not accepting review comments properly, so this new PR recreates the changes with all lessons learned and corrections applied.

Changes Implemented

  • Version Management

    • Bumped version from 0.5.5 to 0.5.6 (PATCH)
    • Updated all version files consistently
    • Added comprehensive CHANGELOG entry
  • Terminology Standardization

    • ✅ Changed "release notes" to "changelog items" throughout for consistency
    • ✅ Clarified "without a release" to "without a GitHub release" for precision
    • ✅ Consistent language across copilot-instructions.md and release_creation.yml
  • Release Guidelines - Minor Releases

    • ✅ Changed from "patch version release notes" to "changelog items from ALL patch version bumps"
    • ✅ Added "including merges without a GitHub release" for clarity
    • ✅ More precise language that matches actual use case
  • Release Guidelines - Major Releases

    • ✅ Changed from "minor release notes" to "changelog items from ALL minor version bumps"
    • ✅ Added "including merges without a GitHub release" for clarity
    • ✅ Added NOTE: "Minor release summaries already include their patches, so summarizing minors covers all changes"
    • ✅ Corrected to match actual script behavior (script extracts only minors, not individual patches)
  • Script Documentation

    • ✅ Updated line 109 to clarify: "For major releases: includes all minor releases since last major (minor releases already include their patches)"
    • ✅ Ensures documentation accurately reflects script implementation
  • Cross-File Consistency

    • ✅ Synchronized .github/ISSUE_TEMPLATE/release_creation.yml with copilot-instructions.md
    • ✅ Both files now have identical guidelines
  • Testing & Validation

    • ✅ All tests passing
    • ✅ Version consistency verified
    • ✅ Script behavior verified against documentation

Key Insight 💡

The generate-release-notes.sh script for major releases extracts only minor versions (X.Y.0), not individual patches. This is the correct approach because:

  1. Each minor release already aggregates all its patch releases
  2. By summarizing minors, you implicitly cover all patches
  3. This avoids duplicate/redundant content in major release notes
  4. The script uses v_patch == "0" filter when range_type="minor"

All Review Comments Addressed

From PR #90:

  1. ✅ Missing version bump → Fixed: Version bumped to 0.5.6
  2. ✅ Inconsistency at line 109 → Fixed: Script documentation now accurate
  3. ✅ Script vs guidelines discrepancy → Fixed: Guidelines match script behavior
  4. ✅ release_creation.yml consistency → Fixed: Synchronized with copilot-instructions.md

From code review:

  1. ✅ Inconsistent terminology → Fixed: Changed "release notes" to "changelog items" in Step 1
  2. ✅ Ambiguous phrasing → Fixed: Changed "without a release" to "without a GitHub release"
  3. ✅ Grammar correction → Fixed: Added article "a" throughout

Files Changed (3 files in this update)

.github/ISSUE_TEMPLATE/release_creation.yml | 8 ++++----
.github/copilot-instructions.md             | 4 ++--
CHANGELOG.md                                | 3 ++-

Supersedes: #90
Fixes: #91
Ready for: Final review and merge

Original prompt

This section details on the original issue you should resolve

<issue_title>Revive stickers PR</issue_title>
<issue_description>#90 is not accepting review comments and copilot follow up, create a new PR with lessons learned from #90 and close the old one</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits February 18, 2026 05:45
- Bump version to 0.5.6
- Fix duplicate conflict avoidance line
- Clarify minor releases include changelog items from patch bumps, including merges
- Clarify major releases include changelog items from minor/patch bumps, including merges
- Update script documentation to reflect major releases include both minor and patch
- Sync release_creation.yml template with updated guidelines

Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
- Script extracts only minor releases (X.Y.0) for major releases, not patches
- Minor releases already include their patches, so this provides complete coverage
- Added clarifying note that minors already include patches
- Ensures guidelines accurately reflect script implementation

Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
Copilot AI changed the title [WIP] Create new PR for stickers based on previous lessons Align release guidelines with script behavior for major/minor aggregation Feb 18, 2026
Copilot AI requested a review from DutchmanNL February 18, 2026 05:48
@DutchmanNL
DutchmanNL marked this pull request as ready for review February 18, 2026 05:49
Copilot AI review requested due to automatic review settings February 18, 2026 05:49

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.

Pull request overview

This PR updates the repository’s release-note guidance to match scripts/generate-release-notes.sh behavior—specifically clarifying that major releases aggregate minor versions (X.Y.0) because minor releases already aggregate their patch changes—then synchronizes the manual release issue template and bumps the template version.

Changes:

  • Clarified minor/major release aggregation rules in .github/copilot-instructions.md (and synced them into the release issue template).
  • Bumped version references from 0.5.50.5.6 across the repo.
  • Added 0.5.6 changelog entries describing the guideline alignment.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
template.md Updates template version string to 0.5.6.
package.json Bumps package version to 0.5.6.
config/metadata.json Bumps tracked template/package version to 0.5.6.
README.md Updates displayed template version to 0.5.6.
CHANGELOG.md Adds 0.5.6 entries describing the guideline alignment.
.github/copilot-instructions.md Clarifies major/minor aggregation wording to match script behavior.
.github/ISSUE_TEMPLATE/release_creation.yml Syncs release-note guideline wording with updated instructions.

Comment thread .github/ISSUE_TEMPLATE/release_creation.yml Outdated
Comment thread .github/ISSUE_TEMPLATE/release_creation.yml Outdated
Comment thread CHANGELOG.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
DutchmanNL and others added 2 commits February 18, 2026 06:54
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Changed "release notes" to "changelog items" in Step 1 for consistency
- Clarified "without a release" to "without a GitHub release" throughout
- Updated CHANGELOG to reflect terminology standardization
- All terminology now consistently refers to changelog items from CHANGELOG.md

Co-authored-by: DutchmanNL <7318445+DutchmanNL@users.noreply.github.com>
Copilot AI requested a review from DutchmanNL February 18, 2026 05:56
@DutchmanNL
DutchmanNL merged commit 8ab14cd into main Feb 18, 2026
3 checks passed
@DutchmanNL
DutchmanNL deleted the copilot/revive-stickers-pr branch February 18, 2026 05:59
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.

Revive frozen PR

3 participants