Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFE: allow to use multiple commit types per changelog section #148

Open
McFoggy opened this issue Sep 20, 2023 · 4 comments
Open

RFE: allow to use multiple commit types per changelog section #148

McFoggy opened this issue Sep 20, 2023 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@McFoggy
Copy link

McFoggy commented Sep 20, 2023

Would you be open to a change that would allow to group several commit types inside a changelog section, configuration could be something like:

  headlines:
    feat: Features
    "fix,style": Enhancements
    perf: Performance Improvements
    "ci,build,ops": CI/CD
    "chore,docs": Misc
    breakingChange: BREAKING CHANGES

Note that such a change is backward compatible with what exists today.

@qoomon
Copy link
Owner

qoomon commented Sep 20, 2023

Hi @McFoggy, your idea sounds interesting. But first thing first :-) what does RFE stands for?

@qoomon qoomon self-assigned this Sep 20, 2023
@qoomon qoomon added the enhancement New feature or request label Sep 20, 2023
@qoomon
Copy link
Owner

qoomon commented Sep 20, 2023

I think the easiest solution would be to set the same headline for the types and group by headlines, this way you get an syntax error in yaml if you define a value twice.

Example

headlines:
    feat:  Features
    fix:   Enhancements
    style: Enhancements
    perf:  Performance Improvements
    ci:    CI/CD
    build: CI/CD
    ops:   CI/CD
    chore: Misc
    docs:  Misc
    breakingChange: BREAKING CHANGES

Because it is an edge case, the redundancy is okay in my opinion.
WDYT?

@qoomon
Copy link
Owner

qoomon commented Sep 21, 2023

Or I could add a new sections field e.g.

sections:
   Features: [feat]
   Enhancements: [fix, style]
   Performance Improvements: [perf]
   CI/CD: [ci, build, ops]
   Misc: [chore, docs]
   BREAKING CHANGES: [breakingChange]

@qoomon
Copy link
Owner

qoomon commented Sep 29, 2023

The new approach could also replace the commitTypeslist
before

changelog:
 commitTypes:
  - feat
  - fix
  - perf
  - merge
  headlines:
    feat: Features
    fix: Bug Fixes
    perf: Performance Improvements
    merge: Merges
    breakingChange: BREAKING CHANGES
changelog:
  categories:
    Features: [feat]
    Bug Fixes: [fix]
    Performance Improvements: [perf]
    Merges: [merge]
    BREAKING CHANGES: [breakingChange]

or

changelog:
  categories:
  - title: Features
    commitTypes: 
    - feat
  - title: Bug Fixes
    commitTypes: 
    - fix
  - title: Performance Improvements
    commitTypes: 
    - perf
  - title: Merges
    commitTypes: 
    - merge
  - title: BREAKING CHANGES
    commitTypes: 
    - breakingChange

WDYT?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants