Skip to content

Support symbols in changelog message subcategory#9697

Merged
aduth merged 2 commits intomainfrom
aduth-changelog-script-symbol-subcategory
Dec 4, 2023
Merged

Support symbols in changelog message subcategory#9697
aduth merged 2 commits intomainfrom
aduth-changelog-script-symbol-subcategory

Conversation

@aduth
Copy link
Contributor

@aduth aduth commented Dec 4, 2023

🛠 Summary of changes

Updates changelog script to support use of more symbols in subcategories. Previously, this was limited to \w - (most alphanumeric, underscore, dash, and spaces). The current logic allows for everything other than commas.

Related Slack conversation: https://gsa-tts.slack.com/archives/C05MGJ72GU9/p1701709507202099

📜 Testing Plan

The commit of this pull request is self-verifying, so observe that build passes.

changelog: Internal, Build Tooling (Changelog Script), Support symbols in changelog message subcategory
@aduth aduth requested a review from jmdembe December 4, 2023 17:32
@jmdembe
Copy link
Contributor

jmdembe commented Dec 4, 2023

This change looks great! What do you think about adding a note about allowed characters in the CHANGELOG file?

@aduth
Copy link
Contributor Author

aduth commented Dec 4, 2023

What do you think about adding a note about allowed characters in the CHANGELOG file?

Do you mean being clearer about which characters are supported within the changelog of this pull request? Or some other documentation?

@jmdembe
Copy link
Contributor

jmdembe commented Dec 4, 2023

What do you think about adding a note about allowed characters in the CHANGELOG file?

Do you mean being clearer about which characters are supported within the changelog of this pull request? Or some other documentation?

I was thinking about being clearer in the CONTRIBUTING.md document, specifically under pull requests.

@aduth
Copy link
Contributor Author

aduth commented Dec 4, 2023

Gotcha. My hope is generally that we should want to support anything, though I suppose it could be a little clearer that it can't contain a comma (at least as of now). I'll update.

@aduth
Copy link
Contributor Author

aduth commented Dec 4, 2023

Updated CONTRIBUTING.md guidance in 6513471

@aduth aduth merged commit 106280a into main Dec 4, 2023
@aduth aduth deleted the aduth-changelog-script-symbol-subcategory branch December 4, 2023 19:16
@solipet solipet mentioned this pull request Dec 7, 2023
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.

3 participants