Add --changelog-preset option to customize --conventional-commits output #1111

alan-agius4 · 2017-11-10T09:29:19Z

…gular`

Description

Lerna uses angular as changelog preset, in my case my lerna repo is hosted on a private bitbucket server. For the angular preset is built for usage with github in my case I want to use some other preset such as angular-bitbucket

Motivation and Context

this issue has already been highlighted in #850

How Has This Been Tested?

Unit Tests

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

evocateur

A few tweaks and we're good to go. Thanks!

evocateur · 2017-11-15T21:40:15Z

test/PublishCommand.js

+  cwd: testDir
+});
+
+const execOptsWithChangelogPreset = (testDir) =>


This is only used a handful of places (compared to the execOpts helper), just inline the expect.objectContaining() call.

evocateur · 2017-11-15T21:56:11Z

test/PublishCommand.js

@@ -878,7 +884,9 @@ describe("PublishCommand", () => {

      it("should use conventional-commits utility to guess version bump and generate CHANGELOG", () => {
        return run(testDir)(
-          "--conventional-commits"
+          "--conventional-commits",
+          "--changelog-preset",


This should be in a separate test case (it()) in both modes to preserve the default cases. It only needs to assert one call, and none of the snapshots, of the existing --conventional-commits tests.

diff --git a/test/PublishCommand.js b/test/PublishCommand.js index c6d14eb8..ae0e8dde 100644 --- a/test/PublishCommand.js +++ b/test/PublishCommand.js @@ -905,6 +905,33 @@ describe("PublishCommand", () => { }); }); }); + + it("accepts --changelog-preset option", () => { + return run(testDir)( + "--conventional-commits", + "--changelog-preset", + "foo-bar" + ).then(() => { + const name = "package-3"; + const version = "3.0.0"; + const location = path.join(testDir, "packages", name); + + expect(ConventionalCommitUtilities.recommendIndependentVersion).toBeCalledWith( + expect.objectContaining({ name, version }), + expect.objectContaining({ + cwd: testDir, + changelogPreset: "foo-bar", + }) + ); + expect(ConventionalCommitUtilities.updateIndependentChangelog).toBeCalledWith( + expect.objectContaining({ name, location }), + expect.objectContaining({ + cwd: testDir, + changelogPreset: "foo-bar", + }) + ); + }); + }); }); describe("fixed mode", () => { @@ -960,6 +987,33 @@ describe("PublishCommand", () => { ); }); }); + + it("accepts --changelog-preset option", () => { + return run(testDir)( + "--conventional-commits", + "--changelog-preset", + "baz-qux" + ).then(() => { + const name = "package-5"; + const version = "1.0.0"; + const location = path.join(testDir, "packages", name); + + expect(ConventionalCommitUtilities.recommendFixedVersion).toBeCalledWith( + expect.objectContaining({ name, version, location }), + expect.objectContaining({ + cwd: testDir, + changelogPreset: "baz-qux", + }) + ); + expect(ConventionalCommitUtilities.updateFixedChangelog).toBeCalledWith( + expect.objectContaining({ name, location }), + expect.objectContaining({ + cwd: testDir, + changelogPreset: "baz-qux", + }) + ); + }); + }); }); });

evocateur · 2017-11-15T21:58:52Z

src/commands/PublishCommand.js

-        rejectCycles: this.options.rejectCycles
-      })
-      : [this.packagesToPublish];
+      this.batchedPackagesToPublish = this.toposort


Thanks for catching this missing indent!

evocateur · 2017-11-15T22:04:11Z

src/commands/PublishCommand.js

@@ -419,7 +425,12 @@ export default class PublishCommand extends Command {
        version: update.package.version,
        location: update.package.location
      };
-      const recommendedVersion = recommendVersionFn(pkg, this.execOpts);
+
+      const changelogOptions = Object.assign({}, this.execOpts, {


Let's make this a lazy getter, so we only have to merge the options once:

diff --git a/src/commands/PublishCommand.js b/src/commands/PublishCommand.js index 9edf8ad5..65222478 100644 --- a/src/commands/PublishCommand.js +++ b/src/commands/PublishCommand.js @@ -152,6 +152,20 @@ export default class PublishCommand extends Command { }); } + get changelogOpts() { + if (!this._changelogOpts) { + const { + changelogPreset, + } = this.options; + + this._changelogOpts = Object.assign({}, this.execOpts, { + changelogPreset, + }); + } + + return this._changelogOpts; + } + initialize(callback) { this.gitRemote = this.options.gitRemote || "origin"; this.gitEnabled = !(this.options.canary || this.options.skipGit);

Then just pass this.changelogOpts to the various functions.

evocateur · 2017-11-15T22:04:51Z

src/commands/PublishCommand.js

@@ -574,18 +589,17 @@ export default class PublishCommand extends Command {

      // we can now generate the Changelog, based on the
      // the updated version that we're about to release.
-      if (this.options.conventionalCommits) {
+      if (conventionalCommits) {


Thanks, this was bugging me. :)

alan-agius4 · 2017-11-16T07:56:53Z

@evocateur, thanks for the feedback. I updated it :)

…ngular`

evocateur · 2017-11-16T23:06:36Z

Thanks!

engfragui · 2018-02-23T02:50:00Z

@alan-agius4 This --changelog-preset option to customize --conventional-commits is exactly what I need right now, since my organization hosts code on bitbucket as well (I know...).

However this new and exciting option doesn't seem to work for me. I'm using lerna v2.9.0 (but I also tried with v2.6.0), yarn 1.3.2, node 8.

I'm trying to run lerna publish this way: lerna publish --skip-npm --skip-git --conventional-commits --changelog-preset=angular-bitbucket but I get the same result of lerna publish --skip-npm --skip-git --conventional-commits (same command, but without --changelog-preset option).

It makes me think that --changelog-preset gets completely ignored, also because I get the same result even if I do --changelog-preset=foo-bar or passing any other invalid changelog preset.

Should I add anything to my package.json and/or install additional yarn dependencies?

Thank you for your help

Update: the result I'm referring to is that a CHANGELOG.md gets generated with the right commit messages, but the links to the commits are github-style and not bitbucket-style.

evocateur · 2018-02-23T03:08:01Z

The changelog preset in lerna 2.x is unfortunately not passed into the recommended-bump cli (choosing the version), only to the conventional-changelog cli (that generates the actual changelog output). Lerna 3.0’s first alpha (available under the “next” dist-tag) passes the preset to both APIs programmatically, perhaps that might solve your issue?

…

On Feb 22, 2018, at 18:50, Francesca Guiducci ***@***.***> wrote: @alan-agius4 This --changelog-preset option to customize --conventional-commits is exactly what I need right now, since my organization hosts code on bitbucket as well (I know...). However this new and exciting option doesn't seem to work for me. I'm using lerna v2.9.0 (but I also tried with v2.6.0), yarn 1.3.2, node 8. I'm trying to run lerna publish this way: lerna publish --skip-npm --skip-git --conventional-commits --changelog-preset angular-bitbucket but I get the same result of lerna publish --skip-npm --skip-git --conventional-commits (same command, but without --changelog-preset option). It makes me think that --changelog-preset gets completely ignored, also because I get the same result even if I do --changelog-preset foo-bar or passing any other invalid changelog preset. Should I add anything to my package.json and/or install additional yarn dependencies? Thank you — You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub, or mute the thread.

alan-agius4 · 2018-02-23T04:06:06Z

Yes, you need to install this
https://www.npmjs.com/package/conventional-changelog-angular-bitbucket

@evocateur the reason why the preset is only passed to the conventional-changelog is
because of issue #1185 and if you try to pass preset to recommanded bump, you’ll get an error.

I’ll try to test the alpha soon, to see if thats still a problem

engfragui · 2018-02-23T04:18:14Z

Thank you both. I just updated my previous comment, clarifying what result I expect (CHANGELOG.md with bitbucket-style links), and what is the one I'm actually getting (CHANGELOG.md with github-style links).

From your answers it looks like the bitbucket preset should correctly be passed to conventional-changelog already in the 2.6+ versions and I should get a bitbucket-style changelog, which unfortunately is not what's happening at the moment.

I tried installing https://www.npmjs.com/package/conventional-changelog-angular-bitbucket and then lerna publish again, but it made no difference.

alan-agius4 · 2018-02-23T13:36:19Z

Hey @engfragui,

Sorry that I didn't provide a lot of info earlier but I was getting on a plane.

I tried things out a bit on one of my bitbuckets repos, and you need to do a couple of things.

Install the conventional-changelog-angular-bitbucket in the root
In each of the packages/libs package.json you need to specify the below

  "repository": "https://bitbucketsson.betsson.local/projects/WF/repos/obg.ngx.packages", // note, this should not end with `.git` and this is typically the url you use to browse the repo.
  "bugs": {
    "url": "https://jirasson.betsson.local/browse" // this can be a link to your Jira. If you don't have one the whole section can be omitted.
  },

in lerna.json add the below;

"publish": {
   "changelogPreset": "angular-bitbucket",
    "conventionalCommits": true		
},

Alternatively, you can use the command line argument --changelog-preset=angular-bitbucket

Note re invalid presets
If you provide an invalid preset for instance foo, No error will be thrown. I am not sure if this is something not handled by lerna or by conventional-changelog, but properly we should also look into this,

engfragui · 2018-02-23T23:37:19Z

Thank you @alan-agius4, your comment was extremely helpful.

In the end it was sufficient to add:

"repository": {
    "type": "git",
    "url": "https://bitbucketsson.betsson.local/projects/WF/repos/obg.ngx.packages" // note, this should not end with `.git` and this is typically the url you use to browse the repo.
  },

to the root level package.json (in my case there was no need to add it into each of the packages/package.json).

My mistake was that I didn't have "repository" at all. For some reason I assumed it was not needed since the CHANGELOG.md that was generated via lerna publish had links to my bitbucket repo already without me having to specify "repository" (even though they were github-style and not bitbucket-style like I wanted).

Just for the sake of future readers, the few lines that need to be add to lerna.json are:

"command": {
    "publish": {
      "conventionalCommits": true,
      "changelogPreset": "angular-bitbucket"
    }
  }

("publish" needs to be inside "command").

Thank you again for your help, I would buy you lunch for a week if I could.

evocateur · 2018-02-24T01:18:58Z

Thanks @alan-agius4!

alan-agius4 · 2018-02-24T06:48:06Z

Glad to hear the issue is solved 😁

If yo are not using the ‘bugs’ field, indeed the root package.json sill suffice.

bertho-zero · 2018-04-06T09:31:25Z

How to use a custom preset? the -p option is used for an official preset but for a local config file you have to use the -n option of conventional-changelog.

bertho-zero · 2018-04-06T11:14:10Z

@evocateur When I use the changelogPreset option with the value @openagenda/oa, it's works with:

./node_modules/.bin/lerna publish

But the following command ignore my preset:

lerna publish

The two lerna have the same version (2.9.0), @openagenda/oa is replaced by @openagenda/conventional-changelog-oa by conventional-changelog but not found/used by my global lerna.

evocateur · 2018-04-06T14:55:37Z

Your preset is also installed globally?

…

On Apr 6, 2018, at 04:14, Kévin Berthommier ***@***.***> wrote: @evocateur When I use the changelogPreset option with the value @openagenda/oa, it's works with: ./node_modules/.bin/lerna publish But the following command ignore my preset: lerna publish The two lerna have the same version (2.9.0), @openagenda/oa is replaced by @openagenda/conventional-changelog-oa by conventional-changelog but not found/used by my global lerna. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

bertho-zero · 2018-04-06T16:46:19Z

No my preset is in my lerna monorepo, but I am in it (it's my current working directory).

evocateur · 2018-04-06T17:00:32Z

If I had to guess, it's a limitation of how conventional-changelog-cli resolves its preset argument. A similar limitation for eslint plugins/config that will fail if a global eslint is used (instead of the locally-installed copy).

Lerna 3 always uses the locally-installed version, even when called from a global installation. Also, conventional-changelog-cli has been replaced by direct conventional-changelog API calls, with a much better custom preset experience overall.

mocheng · 2018-06-12T05:45:22Z

I have a customized preset installed at root node_modules. For lerna v2.6.0, it is interesting that publish command can find the preset with argument --canary, but fail without --canary.

Upgrade to v3 beta version solves the problem.

lock · 2018-12-27T04:24:59Z

This thread has been automatically locked because there has not been any recent activity after it was closed. Please open a new issue for related bugs.

alan-agius4 force-pushed the feature/changelog-preset branch from 01c0f71 to 0eef606 Compare November 10, 2017 09:39

alan-agius4 changed the title ~~feat(publish): Implement support for changelog presets other than `an…~~ Implement support for changelog presets other than `an… Nov 10, 2017

alan-agius4 force-pushed the feature/changelog-preset branch 2 times, most recently from e667ab1 to ed47f70 Compare November 10, 2017 13:42

evocateur suggested changes Nov 15, 2017

View reviewed changes

alan-agius4 force-pushed the feature/changelog-preset branch 2 times, most recently from 3bfe55d to 1a5026b Compare November 16, 2017 07:55

feat: publish - implement support for changelog presets other than `a…

d3cd95c

…ngular`

alan-agius4 force-pushed the feature/changelog-preset branch from 4365b3c to d3cd95c Compare November 16, 2017 11:12

evocateur approved these changes Nov 16, 2017

View reviewed changes

evocateur added the Tag: Enhancement label Nov 16, 2017

evocateur changed the title ~~Implement support for changelog presets other than `an…~~ Add --changelog-preset option to customize --conventional-commits output Nov 16, 2017

evocateur changed the title ~~Add --changelog-preset option to customize --conventional-commits output~~ Add --changelog-preset option to customize --conventional-commits output Nov 16, 2017

evocateur merged commit da3e30f into lerna:master Nov 16, 2017

alan-agius4 deleted the feature/changelog-preset branch November 17, 2017 05:08

This was referenced Jan 9, 2018

Update lerna in / from 2.5.1 to 2.6.0 src-zone/material#209

Closed

Update 20 dependencies from npm storybookjs/storybook#2700

Merged

Update 6 dependencies from npm JetBrains/ring-ui#66

Merged

This was referenced Jan 18, 2018

Feature request: use custom preset for conventional-changelog-cli #786

Closed

feat: add ability to specify conventional changelog preset conventional-changelog/standard-version#170

Closed

lock bot locked as resolved and limited conversation to collaborators Dec 27, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add --changelog-preset option to customize --conventional-commits output #1111

Add --changelog-preset option to customize --conventional-commits output #1111

alan-agius4 commented Nov 10, 2017 •

edited

Loading

evocateur left a comment

evocateur Nov 15, 2017

evocateur Nov 15, 2017

evocateur Nov 15, 2017

evocateur Nov 15, 2017

evocateur Nov 15, 2017

alan-agius4 commented Nov 16, 2017

evocateur commented Nov 16, 2017

engfragui commented Feb 23, 2018 •

edited

Loading

evocateur commented Feb 23, 2018 via email

alan-agius4 commented Feb 23, 2018 •

edited

Loading

engfragui commented Feb 23, 2018 •

edited

Loading

alan-agius4 commented Feb 23, 2018 •

edited

Loading

engfragui commented Feb 23, 2018 •

edited

Loading

evocateur commented Feb 24, 2018

alan-agius4 commented Feb 24, 2018 •

edited

Loading

bertho-zero commented Apr 6, 2018 •

edited

Loading

bertho-zero commented Apr 6, 2018

evocateur commented Apr 6, 2018 via email

bertho-zero commented Apr 6, 2018

evocateur commented Apr 6, 2018

mocheng commented Jun 12, 2018

lock bot commented Dec 27, 2018

Add --changelog-preset option to customize --conventional-commits output #1111

Add --changelog-preset option to customize --conventional-commits output #1111

Conversation

alan-agius4 commented Nov 10, 2017 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

evocateur left a comment

Choose a reason for hiding this comment

evocateur Nov 15, 2017

Choose a reason for hiding this comment

evocateur Nov 15, 2017

Choose a reason for hiding this comment

evocateur Nov 15, 2017

Choose a reason for hiding this comment

evocateur Nov 15, 2017

Choose a reason for hiding this comment

evocateur Nov 15, 2017

Choose a reason for hiding this comment

alan-agius4 commented Nov 16, 2017

evocateur commented Nov 16, 2017

engfragui commented Feb 23, 2018 • edited Loading

evocateur commented Feb 23, 2018 via email

alan-agius4 commented Feb 23, 2018 • edited Loading

engfragui commented Feb 23, 2018 • edited Loading

alan-agius4 commented Feb 23, 2018 • edited Loading

engfragui commented Feb 23, 2018 • edited Loading

evocateur commented Feb 24, 2018

alan-agius4 commented Feb 24, 2018 • edited Loading

bertho-zero commented Apr 6, 2018 • edited Loading

bertho-zero commented Apr 6, 2018

evocateur commented Apr 6, 2018 via email

bertho-zero commented Apr 6, 2018

evocateur commented Apr 6, 2018

mocheng commented Jun 12, 2018

lock bot commented Dec 27, 2018

alan-agius4 commented Nov 10, 2017 •

edited

Loading

engfragui commented Feb 23, 2018 •

edited

Loading

alan-agius4 commented Feb 23, 2018 •

edited

Loading

engfragui commented Feb 23, 2018 •

edited

Loading

alan-agius4 commented Feb 23, 2018 •

edited

Loading

engfragui commented Feb 23, 2018 •

edited

Loading

alan-agius4 commented Feb 24, 2018 •

edited

Loading

bertho-zero commented Apr 6, 2018 •

edited

Loading