Skip to content

Categorise commits based on  #12

@TTitcombe

Description

@TTitcombe

Is your feature request related to a problem? Please describe.
Some teams use prefixes on their commit messages to indicate the type of change. If prefixes are present, they should take precedence over other categorisation methods

Describe the solution you'd like
In the pyproject config section for doculog, read an optional field which takes a list of key/value pairs for prefix/category. E.g.

[bug] = Fixed
[feat] = Added
[depr] = Deprecated
[misc] =

So a commit [bug] some bug fix would be classified as a "Fixed" action. A prefix could be given an empty category in the config to denote that that action should not be included in the changelog. In the above example, a commit [misc] Some random stuff would not be present in the changelog.

Describe alternatives you've considered
None

Additional context
N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions