Add the ability to specify Conventional Changelog Options
See original GitHub issueDescription
conventional-changelog-cli
has the ability to pass in a json file with various configuration options that are passed to conventional-changelog-core
. This would be a convenient option for issue trackers and git repositories that don’t follow the same standards as GitHub.
Here’s an example configuration:
{
"changelogOpts": {
"preset": "angular"
},
"parserOpts": {
"issuePrefixes": ["custom-issue-prefix-"]
},
"writerOpts": {
"headerPartial": "{{version}} {{~#if date}} ({{date}})\n {{~/if}}",
"commitPartial": "* {{this.subject}} \n\n{{~!-- commit link --}} {{#if @root.linkReferences~}} \n ([{{hash}}]({{~@root.repoUrl}}/{{~@root.commit}}/{{hash}})){{~else}}{{~hash}}{{~/if}}"
}
}
Issue Analytics
- State:
- Created 7 years ago
- Reactions:9
- Comments:15 (6 by maintainers)
Top Results From Across the Web
How To Automatically Generate A Helpful Changelog From ...
Auto-Generate Changelog · Follow the Conventional Commits Specification in your repository. We will use @commitlint/config-conventional to enforce this via Git ...
Read more >conventional-changelog-cli
Used by AngularJS, JSHint and related projects. Easy fully automate changelog generation. You could still add more points on top of it. Ignoring...
Read more >cz-conventional-changelog-with-jiraid-detection
Commitizen adapter following the conventional-changelog format with an extra step to insert Jira ID.. Latest version: 1.0.4, last published: ...
Read more >conventional commit messaging
A specification for adding human and machine readable meaning to commit messages. ... within parenthesis, e.g., feat(parser): add ability to parse arrays ....
Read more >How to generate Changelog using Conventional Commits
The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating ...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@smeijer @nick-woodward @Tapppi dusting off an old issue as I go through my giant GitHub issue backlog; I don’t hate the idea of introducing a
.svrc
andstandard-version
stanza in thepackage.json
to standard-version for controlling a few select configuration options.I think we should make things a bit less À la cart than
conventional-changelog-cli
; which suffers from the paradox of choice. yargs has great built in support for this functionality.If an issue doesn’t already exist, perhaps we could open one to bike-shed some initial configuration options; mainly I think introducing options that would allow us to support platforms other than GitHub, e.g., BitBucket, would be beneficial.
+1, I would like an option to not include any links. This to make it easy to generate public changelogs for a private repo.