Skip to content

Commit Parser has the ability to say "ignore this commit" for the purposes of building the changelog #778

Closed
@cc-stjm

Description

@cc-stjm

Description

Provide the ability for a custom Commit Parser to signal that a commit should not be output to the changelog, but should be ignored.

Use cases

I've got a monorepo where I want different directories within it to each be independently versioned (using tags like dir_a-v1.0.1), which I can achieve with a custom parser that opts to ignore commits where there weren't any changes in the directories it cares about.

This all works fine, apart from the ignored commits still appear in the changelog

Possible implementation

Add to ParsedCommit a include_in_changelog property which defaults to true.

Use this to decide whether to ignore the commit, in the same way that commits matching exclude_commit_patterns are ignored.

I don't believe that change would break any backward compatibility.

Metadata

Metadata

Assignees

No one assigned

    Labels

    confirmedPrevent from becoming stalefeatureA new feature or a feature request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions