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

Customizing code convention #59

Open
sandzhaj opened this issue Oct 8, 2023 · 3 comments · May be fixed by #60
Open

Customizing code convention #59

sandzhaj opened this issue Oct 8, 2023 · 3 comments · May be fixed by #60

Comments

@sandzhaj
Copy link
Contributor

sandzhaj commented Oct 8, 2023

Is your feature request related to a problem? Please describe.
The idea of PR #56 seems awesome. It could bring some configuration freedom like in git-cliff. This would also free up those who would like to translate the CHANGELOG.md sections into their native language.

Describe the solution you'd like
I'll push solution today

@pawamoy
Copy link
Owner

pawamoy commented Oct 8, 2023

Do you want to continue the work in #56? Or maybe @oesteban was just waiting for #55 to be released, which is now the case.

@sandzhaj
Copy link
Contributor Author

sandzhaj commented Oct 8, 2023

I'm working on my branch and it's almost done, but I'm slightly stuck with the sections. I'm unsure about @oesteban's progress. I noticed that #55 was merged in August and using it for a month, but I need that functionality for now, so I started working on it. :)

@sandzhaj
Copy link
Contributor Author

sandzhaj commented Oct 8, 2023

Ok, here we are

Example

[tool.git-changelog]
convention = "conventional"
sections = "build,chore,doc,n,feat"
minor-types = "feat,n"
...

[tool.git-changelog.rewrite-convention]
build = "Build"
chore = "Chore"
ci = "Continuous Integration"
deps = "Dependencies"
doc = "Documentation"
feat = "Features"
n = "Notes"

We initially choose our convention from the basic, conventional, or angular options. If we want to customize (or translate) our convention, we define a rewrite-convention with all the TYPES we intend to use. In this case, specifying sections is mandatory. Additionally, we can use minor-types to specify types for minor versions, especially if the default convention option doesn't suit our needs."

sandzhaj added a commit to sandzhaj/git-changelog that referenced this issue Oct 8, 2023
@sandzhaj sandzhaj linked a pull request Oct 8, 2023 that will close this issue
sandzhaj added a commit to sandzhaj/git-changelog that referenced this issue Oct 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants