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

[changelog] Categories should be identifiable separatedly from their formatting #619

Closed
aalmiray opened this issue Dec 22, 2021 · 2 comments
Assignees
Labels
BREAKING CHANGE enhancement New feature or request
Milestone

Comments

@aalmiray
Copy link
Member

aalmiray commented Dec 22, 2021

Categories have a title property that's used to render them on the changelog, as well as matching and merging settings applied by presets. This poses a problem when the formatting includes special character such as spaces and emojis.

I'd be better if categories had a key (identifier) used for matching and keep the title for rendering. For backward compatibility the value of key will be set to title if key is not explicitly defined.

CC @michael-simons @kcpeppe

@aalmiray aalmiray added the enhancement New feature or request label Dec 22, 2021
@aalmiray aalmiray added this to the 0.10.0 milestone Dec 22, 2021
@aalmiray aalmiray self-assigned this Dec 22, 2021
aalmiray added a commit to jreleaser/jreleaser.github.io that referenced this issue Dec 22, 2021
@aalmiray
Copy link
Member Author

@michael-simons @kcpeppe please use the key property on a category to match customizations made to the changelog.

@michael-simons
Copy link

Thanks @aalmiray for the heads up, works nicely:

michael-simons/neo4j-migrations@ffddee7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BREAKING CHANGE enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants