question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add the ability to specify Conventional Changelog Options

See original GitHub issue

Description

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:closed
  • Created 7 years ago
  • Reactions:9
  • Comments:15 (6 by maintainers)

github_iconTop GitHub Comments

4reactions
bcoecommented, Nov 29, 2017

@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 and standard-version stanza in the package.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.

3reactions
smeijercommented, Sep 14, 2017

+1, I would like an option to not include any links. This to make it easy to generate public changelogs for a private repo.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found