Skip to content

Add extra details to release from commit message #223

Closed

Description

@danth

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.

Activity

  1. added
    featureA new feature or a feature request
    on Apr 27, 2020
  2. added this to the Better Changelogs milestone on Apr 27, 2020
  3. added
    help-wantedExtra attention is required
    confirmedPrevent from becoming stale
    and removed on May 6, 2024
  4. github-actions commented on Jul 6, 2024

    @github-actions

    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?

  5. codejedi365 commented on Jul 6, 2024

    @codejedi365
    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.

  6. github-actions commented on Sep 5, 2024

    @github-actions

    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?

  7. 38 remaining items

  8. added 10 commits that reference this issue on Feb 1, 2025
    fbc77cc
    e130948
    72dec7b
    ff5aecf
    a335b85
    e165d62
    7d07f0d
    bacef8f
    a242f9d
    252d82b
  9. added a commit that references this issue on Feb 2, 2025
    834ce32
  10. codejedi365 commented on Feb 6, 2025

    @codejedi365
    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureA new feature or a feature request

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions