Add option to ignore parsing of commit body #733
Comments
|
Working on a solution to fix the breaking of the changelog with squashed commits, with the intent to actually parse the squashed commits. I'm glad I read this to possibly add the setting to ignore the commit body. Also, just curious which parser are you using? |
|
Hey, glad to hear that! Currently had to revert back and would love to someday go back to the current version. I am using the default Angular parser. |
|
I appreciate it, I'll let you know when it gets merged and published |
|
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? |
|
No update here yet, I have been working on other smaller features and fixes. |
|
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? |
|
Unfortunately no movement here yet |
|
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? |
|
Should have movement here in the next month as I'm re-engaging my fix for squash commits that got stale before |
|
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? |
|
Very close to completion here between a new configurable feature of parsing squash commits and the subsequent change of the default changelog to only display the subject lines of commits by default. This change is now possible because of squash commit parsing which is what we couldn't display unless we included the whole commit message in the changelog. Now it will no longer obscure squashed commit types and each change will be mixed in with the rest of the changes while maintaining a smaller and succinct commit history. |
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Dec 20, 2024
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Dec 20, 2024
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 12, 2025
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 12, 2025
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 12, 2025
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 12, 2025
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 18, 2025
Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default Markdown changelog template and release notes template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 18, 2025
…tructuredText template Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default ReStructured changelog template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 26, 2025
Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default Markdown changelog template and release notes template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 26, 2025
…tructuredText template Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default ReStructured changelog template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 27, 2025
Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default Markdown changelog template and release notes template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 27, 2025
…tructuredText template Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default ReStructured changelog template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 27, 2025
Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default Markdown changelog template and release notes template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 27, 2025
…tructuredText template Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default ReStructured changelog template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 28, 2025
Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default Markdown changelog template and release notes template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Jan 28, 2025
…tructuredText template Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default ReStructured changelog template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
|
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? |
|
Squash commits are now supported with v9.17.0, but I decided to push the change of switching the default changelog to only the summary lines to the next major change, v10. If you want it today, take a look at the PSR custom template or |
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Feb 1, 2025
Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default Markdown changelog template and release notes template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Feb 1, 2025
…tructuredText template Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default ReStructured changelog template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Feb 2, 2025
Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default Markdown changelog template and release notes template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Feb 2, 2025
…tructuredText template Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default ReStructured changelog template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Feb 5, 2025
Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default Markdown changelog template and release notes template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
codejedi365
added a commit
to codejedi365/python-semantic-release
that referenced
this issue
Feb 5, 2025
…tructuredText template Remove the code that writes out the rest of the commit message from the default template. BREAKING CHANGE: The default ReStructured changelog template will no longer print out the entire commit message contents, instead, it will only print the commit subject line. This comes to meet the high demand of better formatted changelogs and requests for subject line only. Originally, it was a decision to not hide commit subjects that were included in the commit body via the `git merge --squash` command and PSR did not have another alternative. At this point, all the built-in parsers have the ability to parse squashed commits and separate them out into their own entry on the changelog. Therefore, the default template no longer needs to write out the full commit body. See the commit parser options if you want to enable/disable parsing squash commits. Resolves: python-semantic-release#733
|
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? |
|
Planning to release this as a major change very shortly to use the new template that does not include the rest of the commit body as the default. Stay tuned. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
Add an option to ignore the body of a commit message during commit parsing. Ideally in
commit_parser_options.Use cases
From v7 to v8, the changelog seems to use all the information from the commit message. This introduces issues when using squash and merge and keeping the default commit messages (actually breaks the changelog for some reason; e.g., pre-commit is complaining about mixed line endings). Since the commit body - at least for me - does not contain any relevant information (for the changelog), I would rather not use it at all.
Possible implementation
Add a
use_bodyflag incommit_parser_optionsThe text was updated successfully, but these errors were encountered: