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: handle issue links in BREAKING_CHANGE notes section #1757

Merged
merged 3 commits into from Nov 22, 2022

Conversation

chingor13
Copy link
Contributor

@chingor13 chingor13 commented Nov 22, 2022

This is somewhat hacky as we are delegating the changelog generation to the conventional-changelog-writer package which is not doing the explicit issue linking for notes. That library has not been updated in months so it's unlikely that we can fix it there.

In the future, we should consider bringing the changelog generation in-house into the DefaultChangelogNotes class.

Fixes #1754

@product-auto-label product-auto-label bot added the size: s Pull request size is small. label Nov 22, 2022
@product-auto-label product-auto-label bot added size: m Pull request size is medium. and removed size: s Pull request size is small. labels Nov 22, 2022
@chingor13 chingor13 changed the title test: failing test for breaking change section using extended link format fix: handle issue links in BREAKING_CHANGE notes section Nov 22, 2022
@chingor13 chingor13 marked this pull request as ready for review November 22, 2022 20:02
@chingor13 chingor13 requested a review from a team as a code owner November 22, 2022 20:02
@chingor13 chingor13 requested review from a team and bcoe November 22, 2022 20:02
@chingor13 chingor13 merged commit cd8c04b into main Nov 22, 2022
@chingor13 chingor13 deleted the breaking-change-link branch November 22, 2022 22:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: m Pull request size is medium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

"Breaking change" section does not use fully-expanded issue links
2 participants