Suggest some feature about changelog-generator HOT 18 CLOSED

@vacnex To filter username display you can use filter-author

from changelog-generator.

@vacnex 1 idea, I may need to define templates to achieve this idea.

- name: Generate changelog
  uses: jaywcjlove/changelog-generator@main
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    filter-author: (jaywcjlove|小弟调调™|dependabot|renovate\\[bot\\]|dependabot\\[bot\\]|Renovate Bot)
    filter: '[R|r]elease[d]\s+[v|V]\d(\.\d+){0,2}'
    template: |
        ## Bugs

        {{fix}}

        ## Feature

        {{feat}}{{type}}

        ## Document 

        {{doc}}

@vacnex If you are sure that your idea can be satisfied, I will start to realize it.

from changelog-generator.

@vacnex 2 To exclude logs, you can use the following method.

from changelog-generator.

@vacnex 1 idea, I may need to define templates to achieve this idea.

- name: Generate changelog
  uses: jaywcjlove/changelog-generator@main
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    filter-author: (jaywcjlove|小弟调调™|dependabot|renovate\\[bot\\]|dependabot\\[bot\\]|Renovate Bot)
    filter: '[R|r]elease[d]\s+[v|V]\d(\.\d+){0,2}'
    template: |
        ## Bugs

        {{fix}}

        ## Feature

        {{feat}}{{type}}

        ## Document 

        {{doc}}

@vacnex If you are sure that your idea can be satisfied, I will start to realize it.

great this is what I expected 👍

from changelog-generator.

@vacnex To filter username display you can use filter-author

changelog-generator/action.yml

Lines 13 to 16 in 8488774

	filter-author:
	description: 'Regular expression to filter user name not to display.'
	default: ''
	required: false

my understanding is that this will not display the changlogs created by me, am I understanding its purpose correctly?

from changelog-generator.

@vacnex To filter username display you can use filter-author

changelog-generator/action.yml

Lines 13 to 16 in 8488774

	filter-author:
	description: 'Regular expression to filter user name not to display.'
	default: ''
	required: false

my understanding is that this will not display the changlogs created by me, am I understanding its purpose correctly?

Match "@author", do not display "@author"

from changelog-generator.

@vacnex Upgrade v1.8.0, use template input.

from changelog-generator.

@vacnex Upgrade v1.8.0, use template input.

Just tested

work great, can you add default like "🔶 Nothing change" if type has nothing change

from changelog-generator.

@vacnex Upgrade v1.8.0, use template input.

Just tested work great, can you add default like "🔶 Nothing change" if type has nothing change

I don't understand how Misc matches.

from changelog-generator.

I don't understand how Misc matches.

Im config like this

template: |
         ## Bugs
          {{fix}}
          ## Feature
          {{feat}}
          ## Improve
          {{refactor}}
          {{perf}}
          {{clean}}
          ## Misc 
          {{chore}}
          {{style}}
          {{ci}}
          {{build}}

as you see im add {{chore}} {{style}} {{ci}} {{build}} and my commit list has nothing in these type so ##mics will empty so im want add default if nothing in these type will return 🔶 Nothing change

my expected like this

Bugs

• 🐞 fix: Fixed test 46bccf4

Feature

• 🌟 feat: test feat 3959ee2

Improve

• 💊 clean: remove comment code. 5630fce
• 💊 clean: remove comment code. c255511
• 💊 clean: test clean add83cc

Misc

• 🔶 Nothing change

from changelog-generator.

template: |
  ## Bugs
  {{fix}}
  ## Feature
  {{feat}}
  ## Improve
  {{refactor,perf,clean}}
  ## Misc 
  {{chore,style,ci||🔶 Nothing change}}

@vacnex Do you think it is possible to design such a template? I think it could be very flexible.

from changelog-generator.

@vacnex If you think it's okay, I'll implement this feature.

from changelog-generator.

template: |
  ## Bugs
  {{fix}}
  ## Feature
  {{feat}}
  ## Improve
  {{refactor,perf,clean}}
  ## Misc 
  {{chore,style,ci||🔶 Nothing change}}

@vacnex Do you think it is possible to design such a template? I think it could be very flexible.

hmm i think it's okay but if i define more type so i need add "||🔶 Nothing change" on every type, any else solution?

template: |
  ## Bugs
  {{fix ||🔶 Nothing change}}
  ## Feature
  {{feat ||🔶 Nothing change}}
  ## Improve
  {{refactor,perf,clean ||🔶 Nothing change}}
  ## Misc 
  {{chore,style,ci||🔶 Nothing change}}

from changelog-generator.

@vacnex || xxxx is not defined, will be removed

from changelog-generator.

I'm imagining this
config template like

template: |
  ## Bugs
  {{fix, type}}
  ## Feature
  {{feat}}
  ## Improve
  {{refactor,perf,clean}}
  ## Misc 
  {{chore,style,ci}}

with every {{}} and type defined inside, we will check if just one type like {{feat}} and feat is empty so show "🔶 Nothing change" else more than one type {{fix, type}} and if all defined type is empty then show "🔶 Nothing change"
exp {{fix, type}}
fix emtpy and type not empty => show type
fix and type => show fix and type
fix and type emtpy => show fix
both empty => 🔶 Nothing change

from changelog-generator.

{{refactor,perf,clean ||🔶 Nothing change}} This prompt is defined by myself, because I am in the Chinese area and need to modify it. @vacnex

from changelog-generator.

That's great, I'm looking forward to your next update

from changelog-generator.

@vacnex Upgrade v1.9.1

from changelog-generator.