Skip to content

Credit contributors from skipped commit groups #1351

Description

@michen00

Is there an existing issue or pull request for this?

  • I have searched the existing issues and pull requests

Feature description

For each release, I would like to credit all unique contributors, even if they only make commits.

For instance, I have something like this in my cliff.toml commit_parsers:

    # Internal categories (SKIP)
    { message = "^test", group = "<!-- 04 -->🧪 Tests", skip = true },
    { message = "^ci", group = "<!-- 05 -->💚 Continuous Integration", skip = true },
    { message = "^build", group = "<!-- 06 -->👷 Build", skip = true },
    { message = "^doc", group = "<!-- 07 -->📝 Documentation", skip = true },
    { message = "^refactor", group = "<!-- 08 -->♻️ Refactor", skip = true },
    { message = "^style", group = "<!-- 09 -->🎨 Styling", skip = true },
    { message = "^chore", group = "<!-- 10 -->⚙️ Miscellaneous Tasks", skip = true },

If a contributor only makes test and CI contributions, their commits will not be retrieved and {{ github.contributors }} will not list them.

Desired solution

It could be nice just to have a flag on git cliff to make something like this possible. Alternatively, a nice example of how to do this in the docs would suffice. Or maybe support for a hook so I can incorporate git log info myself.

Alternatives considered

I thought about setting all commit groups to skip = false so all contributors would be available; then some additional logic would hide the sections I originally wanted skipped. However, I worry this may interfere with protect_breaking_commits.

Additional context

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions