Automated changelog: remove Uncategorized header in output and place items at top
#34037
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
|
Size Change: 0 B Total Size: 1.03 MB ℹ️ View Unchanged
|
youknowriad
reviewed
Aug 12, 2021
There was a problem hiding this comment.
This works for me, I wonder if it should be at the top or the bottom of the section.
Curious to here more thoughts from folks doing changelogs and releases cc @priethor
|
I mean...at the bottom was my first instinct but at the top will help the release lead to remember to manually categorize. |
5 tasks
|
Should all items be nested? If so, adding them to the top can help see them and categorize them. If it's agreed some items don't need to be subcategorized, I lean towards leaving them at the end of the section, as it seems they would have a category if they were more prominent. I've personally been trying to nest always to have a more clear, structured changelog, but sometimes it's tough to pick the right subcategory and/or be consistent between releases. All in all, I would lean towards leaving some unnested items at the bottom of the sections. |
youknowriad
approved these changes
Aug 12, 2021
|
Ok ill switch it to be at the bottom again 😀 |
|
I just noticed #34040. If we are removing the indentation it definitely is much more clear to leave uncategorized items at the top, before the nested headings 🙂 |
getdave
force-pushed
the
update/remove-uncategorized-feature
branch
from
93181eb
to
331749b
Compare
|
Ok I've merged in the changes from Going to merge when tests pass. |
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
In #33229 (comment) @youknowriad suggested we remove the
Uncategorizedfeature name from the auto-generated changelog and instead:This PR does this. Here is an example of the new output for a given section which I generated from the
11.3.0Milestone:How has this been tested?
Following testing instructions from #33229.
The only difference here is that you should check that:
Uncategorizedfeature heading in the output.Uncategozedare now place at the top of each section and have no heading.Screenshots
Types of changes
New feature (non-breaking change which adds functionality)
Checklist:
*.native.jsfiles for terms that need renaming or removal).