Skip to content

Remove commit types from subjects in CHANGELOG #924

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.

Sign up for GitHub

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

Jump to bottom
Closed
paduszyk opened this issue May 10, 2024 · 7 comments
Closed

Remove commit types from subjects in CHANGELOG #924

paduszyk opened this issue May 10, 2024 · 7 comments
Labels
confirmed Prevent from becoming stale feature A new feature or a feature request
Milestone
Better Changelogs

Comments

@paduszyk
Copy link

Description

Hey ✋🏻 First of all, thanks for such a great project! 💚

Changelog summarizes changes grouped by types - in the case of the Angular scheme, the type is simply the semantic prefix of the message: ci, chore, feat, etc. Within the given type, all the commits are listed with the prefix repeated, like that:

> ### Fix
> * fix: resolve hofix 
> * fix: fix another bug

so, the prefix is repeated for each commit. I think that removing commit types (and capitalizing the subject) would result in a cleaner CHANGELOG:

> ### Fix
> * Resolve hofix
> * Fix another bug

Use cases

Removing prefixes will reduce redundancy.

Possible implementation

This issue is to share my idea. I don't know how to implement it, I haven't dug into the codebase yet...
@paduszyk paduszyk added the feature A new feature or a feature request label May 10, 2024
@codejedi365
Copy link
Contributor

@paduszyk Thanks for the report, I am working this effort it's just taken me some time to make it public in lieu of other priorities. There is a milestone for improved changelogs that I'm consolidating all of them. Feel free to check out what is planned and add what you would like to see as well.

@codejedi365 codejedi365 added this to the Better Changelogs milestone May 10, 2024
@codejedi365 codejedi365 added the confirmed Prevent from becoming stale label May 10, 2024
@codejedi365
Copy link
Contributor

@paduszyk, one thing I forgot to mention is that if you wanted to see this resolved in your own projects today, you can easily define your own custom changelog template and apply it to your projects.

@wyardley wyardley mentioned this issue Jun 15, 2024
Closed
@github-actions GitHub Actions
Copy link

It has been 60 days since the last update on this confirmed issue. @python-semantic-release/team can you provide an update on the status of this issue?

@github-actions github-actions bot added the needs-update Needs status update from maintainers label Jul 11, 2024
@codejedi365
Copy link
Contributor

Still on the backlog, these changes were put on hold while I attended to other improvements and fixes

@github-actions github-actions bot removed the needs-update Needs status update from maintainers label Jul 12, 2024
@github-actions GitHub Actions
Copy link

It has been 60 days since the last update on this confirmed issue. @python-semantic-release/team can you provide an update on the status of this issue?

@github-actions github-actions bot added the needs-update Needs status update from maintainers label Sep 10, 2024
@codejedi365
Copy link
Contributor

Likely not going to be changed until v10 officially, for v9 use it will require a custom template. Working on a fix for handling squash commits which is the primary reason for a less clean changelog by default.

@github-actions github-actions bot removed the needs-update Needs status update from maintainers label Sep 11, 2024
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 13, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default Markdown changelog
d189f35 
Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 13, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default Markdown changelog
e0e3fe1 
Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 14, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default Markdown changelog
4a138bc 
Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 14, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default reStructuredText te…
da332e7 
…mplate

Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default Markdown changelog
ad76024 
Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default reStructuredText te…
a14d95a 
…mplate

Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default Markdown changelog
1ff5860 
Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default reStructuredText te…
7439cde 
…mplate

Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default Markdown changelog
ddfcf85 
Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default reStructuredText te…
8c05f26 
…mplate

Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default reStructuredText te…
d9b84a1 
…mplate

Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default Markdown changelog
d41cb99 
Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Oct 19, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default reStructuredText te…
d96a6f1 
…mplate

Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Nov 7, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default Markdown changelog
ee9742d 
Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Nov 7, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default reStructuredText te…
c3e3e3a 
…mplate

Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Nov 7, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default Markdown changelog
352a3f7 
Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Nov 7, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default reStructuredText te…
cc0f398 
…mplate

Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Nov 7, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default Markdown changelog
3129892 
Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Nov 7, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default reStructuredText te…
f34c561 
…mplate

Resolves: python-semantic-release#924, python-semantic-release#953
codejedi365 added a commit that referenced this issue Nov 7, 2024
@codejedi365
feat(changelog): add PR/MR url linking to default reStructuredText te…
5f018d6 
…mplate

Resolves: #924, #953
@codejedi365
Copy link
Contributor

🎉 This issue has been resolved in version 9.13.0 🎉

The release is available on:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
confirmed Prevent from becoming stale feature A new feature or a feature request
Projects
None yet
Milestone
Better Changelogs
Development

No branches or pull requests
2 participants
@codejedi365 @paduszyk