jaywcjlove / changelog-generator

A GitHub Action that compares the commit differences between two branches

Home Page:https://jaywcjlove.github.io/changelog-generator/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Feature request: filter conventional commit types

Uninen opened this issue · comments

First, Thank You for this simple and easy to use tool! 🙏

When using a changelog template you get something like this:

### Feature

- feat: my feature

when the conventional commit types are known, and when the template is used, it would be nice to be able to filter away the redundant types from the beginning of the commit message. Ie:

### Feature

- my feature

### Unkown

- notconventional: other commit

Latter is much more readable and human-friendly -- would be nice to be able to do this 👍

@Uninen Do you want to remove the feat: in the commit?

Yes, for all the known conventional types.

@Uninen

show-emoji:
description: 'Show emoji icons.'
default: 'true'
required: false

Don't understand the relevance of above. I've disabled the emojis already, but they don't affect the commit row text in any way (other than the emoji, that is)?

Again, here's the current output:

## Features:
- feat: add feature 1
- feat: add feature 2

Desired output:

## Features:
- add feature 1
- add feature 2

@Uninen

- name: Generate Changelog (show-emoji test)
# uses: jaywcjlove/changelog-generator@main
id: changelogEmoji
uses: ./
with:
filter: '[R|r]elease[d]\s+[v|V]\d(\.\d+){0,2}'
show-emoji: false
remove-type: true

Wow, brilliant. Thanks for adding this! 🙏