Skip to content
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.

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

fix: don't include chore PRs in GH release page #1924

Merged

Conversation

michaelfaith
Copy link
Contributor

PR Checklist

Overview

This change adjusts the release-it config for both this repo, as well as what the create script generates, so that the previous changes to enhance the changelog generation flows through to the github release page too.

I discussed this here release-it/release-it#1025 (comment), and @webpro theorized it was the autoGenerate that overrode the changelog output from being applied to the GH release too.

I created a test repo to verify and confirmed that removing autoGenerate, indeed, fixed the issue: https://github.com/michaelfaith/mf-cta-testing/releases 2.0.2 is after this change, which included both a chore change and fix change, but changelog and GH release page only show the bug fix (notice also the group heading, which isn't in the previous releases). 2.0.1 is before the change, with the original configuration

Closes #1913

This change adjusts the release-it config for both this repo, as well as what the create script generates, so that the previous changes to enhance the changelog generation flows through to the github release page too.

I discussed this here release-it/release-it#1025 (comment), and @webpro theorized it was the autoGenerate that overrode the changelog output from being applied to the GH release too.

I created a test repo to verify and confirmed that removing `autoGenerate`, indeed, fixed the issue: https://github.com/michaelfaith/mf-cta-testing/releases
2.0.2 is after this change, which included both a chore change and fix change, but changelog and GH release page only show the bug fix (notice also the group heading, which isn't in the previous releases). 2.0.1 is before the change, with the original configuration
Copy link
Owner

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Glorious! Fewer lines and a cleaner output. A perfect resolution. Thanks! 🥳

@JoshuaKGoldberg JoshuaKGoldberg merged commit 97cdfad into JoshuaKGoldberg:main Feb 1, 2025
11 checks passed
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.

🐛 Bug: GH Release page should only include user-facing changes
2 participants