The Wayback Machine - https://web.archive.org/web/20210728212049/https://github.com/lerna/lerna/issues/2272
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

Allow customization of CHANGELOG header #2272

Open
lazd opened this issue Sep 17, 2019 · 3 comments
Open

Allow customization of CHANGELOG header #2272

lazd opened this issue Sep 17, 2019 · 3 comments

Comments

@lazd
Copy link
Contributor

@lazd lazd commented Sep 17, 2019

Expected Behavior

It should be possible to customize the header of the generated changelog (or omit it completely).

Current Behavior

The changelog header is hardcoded in https://github.com/lerna/lerna/blob/master/core/conventional-commits/lib/constants.js

Possible Solution

A command.publish.changelogHeader could be added to lerna.json.

Steps to Reproduce (for bugs)

  1. Generate a new changelog for any lerna project with conventional commits
  2. Observe the header
lerna.json

{
  "packages": [
    "components/*",
    "tools/*"
  ],
  "version": "independent",
  "npmClient": "yarn",
  "useWorkspaces": true,
  "command": {
    "publish": {
      "conventionalCommits": true,
      "changelogPreset": "spectrum"
    },
    "version": {
      "message": "chore(release): release"
    }
  }
}

Context

Content strategy advises us that we need to be consistent in how we refer to changelogs. We consider it to be one word, and the lerna template uses title case Change Log and includes text we're rather substitute with something else.

Your Environment

Executable Version
lerna --version 3.16.4
npm --version 6.10.2
yarn --version 1.12.3
node --version 12.6.0
OS Version
NAME VERSION
macOS Mojave 10.14.6
@evocateur
Copy link
Member

@evocateur evocateur commented Nov 20, 2019

Sure, that's reasonable.

@gaoxiaoliangz
Copy link

@gaoxiaoliangz gaoxiaoliangz commented Dec 25, 2019

I've been using standard-version to generate changelogs recently. And I used lerna to do this for my mono repos, but I found it confusing that with the same preset(angular), they produced changelogs with different headers, which is kinda annoying. I think these tools should produce the same results with same presets, or at least a way to customize this.

@rishabhgupta
Copy link

@rishabhgupta rishabhgupta commented Apr 11, 2020

Opened a PR for adding support for custom change log header here #2535

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants