Skip to content

Add extra details to release from commit message #223

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

Closed
danth opened this issue Apr 27, 2020 · 7 comments · Fixed by #1166
Closed

Add extra details to release from commit message #223

danth opened this issue Apr 27, 2020 · 7 comments · Fixed by #1166
Labels
confirmed Prevent from becoming stale feature A new feature or a feature request

Comments

@danth
Copy link
Member

danth commented Apr 27, 2020

Description

Allow some way of adding extra details into the changelog, similar to the text I added manually to v6.1.0. This would be done via the commit message.

Use cases

  • Deprecated features when committing a new feature

Possible implementation

Something similar to BREAKING CHANGE: at the beginning of a paragraph.

@danth danth added the feature A new feature or a feature request label Apr 27, 2020
@danth danth added this to the Better Changelogs milestone Apr 27, 2020
@github-actions github-actions bot added the help-wanted Extra attention is required label May 24, 2020
@github-actions github-actions bot removed the help-wanted Extra attention is required label Oct 23, 2022
@github-actions github-actions bot added the stale label May 6, 2024
@codejedi365 codejedi365 added help-wanted Extra attention is required confirmed Prevent from becoming stale and removed stale labels May 6, 2024
Copy link

github-actions bot commented Jul 6, 2024

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 6, 2024
@codejedi365
Copy link
Contributor

Interesting idea, need to put more thought into how this can be added. I'm leaning towards a paragraph section in a commit message but unfortunately that is not standard to commit parsers. One such answer could be a cli option or interactive cli prompt but this would be problematic for all the different types of automation this project supports and recommends. I partially think that the deprecation message goes into the breaking changes section of the commit which will be extracted separately during parsing. It would take a custom changelog to document them in a separate section.

Either way, still in the backlog and open to community PRs.

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

github-actions bot commented Sep 5, 2024

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 5, 2024
@codejedi365
Copy link
Contributor

Still in the backlog

@github-actions github-actions bot removed the needs-update Needs status update from maintainers label Sep 6, 2024
Copy link

github-actions bot commented Nov 5, 2024

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 Nov 5, 2024
@codejedi365
Copy link
Contributor

codejedi365 commented Nov 9, 2024

Considering using a the keyword heading of NOTICE: in the form a git footer. This will be non-standard but I think it's worth it. Thoughts?

Then in the changelog it will go after any BREAKING CHANGE paragraphs and be place under the title ADDITIONAL RELEASE INFORMATION?

@github-actions github-actions bot removed the needs-update Needs status update from maintainers label Nov 10, 2024
@codejedi365 codejedi365 removed the help-wanted Extra attention is required label Dec 2, 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 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 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 26, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 27, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 27, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 27, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 27, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 27, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 27, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 27, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 27, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 28, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 28, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 28, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Jan 28, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 1, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 1, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 1, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 1, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 2, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 2, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 2, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 2, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 2, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 2, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 2, 2025
codejedi365 added a commit to codejedi365/python-semantic-release that referenced this issue Feb 2, 2025
@codejedi365
Copy link
Contributor

🎉 This issue has been resolved in Version 9.18.0 🎉

You can find more information about this release on the GitHub Releases page.

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

Successfully merging a pull request may close this issue.

2 participants