Skip to content

fix: update release prompt to extract changelog from CHANGELOG.md#4757

Merged
markphelps merged 1 commit into
v2from
fix-release-changelog-prompt
Sep 24, 2025
Merged

fix: update release prompt to extract changelog from CHANGELOG.md#4757
markphelps merged 1 commit into
v2from
fix-release-changelog-prompt

Conversation

@markphelps

@markphelps markphelps commented Sep 24, 2025

Copy link
Copy Markdown
Collaborator

Summary

Updates the release prompt to correctly extract release notes from the CHANGELOG.md file instead of using goreleaser's commit-based changelog generation.

Problem

The current release prompt was designed to work with goreleaser's automatic commit-based changelog generation, but we maintain a manual CHANGELOG.md file. At release time, we want to extract just the specific version's content from CHANGELOG.md, not generate notes from git commits.

Solution

Modified .github/prompts/release.md to:

  • Read the CHANGELOG.md file from the project root
  • Find and extract only the specific version section
  • Preserve exact formatting from the CHANGELOG
  • Handle version tags with or without 'v' prefix

Changes

  • Modified .github/prompts/release.md: Updated prompt to extract content from CHANGELOG.md instead of using .ReleaseNotes variable

The release prompt was using goreleaser's commit-based changelog
generation, but we want to extract the specific version section
from our manually maintained CHANGELOG.md file instead.

Changes:
- Remove dependency on .ReleaseNotes variable (git commits)
- Add instructions to read CHANGELOG.md from project root
- Extract only the specific version's content
- Handle 'v' prefix in version tags
- Preserve exact formatting from CHANGELOG.md

Signed-off-by: Mark Phelps <[email protected]>
@markphelps
markphelps requested a review from a team as a code owner September 24, 2025 00:47
@dosubot dosubot Bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Sep 24, 2025
@dosubot

dosubot Bot commented Sep 24, 2025

Copy link
Copy Markdown

Related Documentation

Checked 3 published document(s). No updates required.

You have 3 draft document(s). Publish docs to keep them always up-to-date

How did I do? Any feedback?  Join Discord

@codecov

codecov Bot commented Sep 24, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 62.64%. Comparing base (9d5ed92) to head (00b3392).
⚠️ Report is 1 commits behind head on v2.

Additional details and impacted files
@@           Coverage Diff           @@
##               v2    #4757   +/-   ##
=======================================
  Coverage   62.64%   62.64%           
=======================================
  Files         132      132           
  Lines       15531    15531           
=======================================
  Hits         9730     9730           
  Misses       5115     5115           
  Partials      686      686           
Flag Coverage Δ
integrationtests 36.32% <ø> (-0.02%) ⬇️
unittests 52.76% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@markphelps
markphelps merged commit 4352158 into v2 Sep 24, 2025
29 of 30 checks passed
@markphelps
markphelps deleted the fix-release-changelog-prompt branch September 24, 2025 10:48
@dosubot

dosubot Bot commented Sep 24, 2025

Copy link
Copy Markdown

Documentation Updates

Checked 3 published document(s). No updates required.

You have 3 draft document(s). Publish docs to keep them always up-to-date

How did I do? Any feedback?  Join Discord

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

Labels

size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant