chore: use "feat" and "fix" in changelogs to make important updates more visible #226
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xiehan
requested review from
mutahhir and
ansgarm
and removed request for
a team
[
|
[
|
[
|
[
|
mutahhir
approved these changes
Oct 9, 2023
[
|
[
|
[
|
[
|
|
I'm going to lock this pull request because it has been closed for at least 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue so we can investigate further. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's been bothering me for some time that some of the most critical updates in our changelogs are super buried. Here's a particularly egregious example:
The really important part here is the provider version change, but it's buried so deep at the end of a long list of routine Projen updates that you might miss it.
IIRC
standard-versionorders changelogs feat > fix > chore, so a simple solution is to use the "feat" or "fix" type here to put the provider version at the start of the changelog instead of at the end. It also feels like more than a chore since upgrading a provider or CDKTF itself could come with new or improved functionality.Companion to cdktf/cdktf-provider-project#343