feat: Split `lerna version` from of `lerna publish` #1522

evocateur · 2018-07-26T00:06:04Z

Description

To facilitate further refactoring, the gigantic PublishCommand needs to be split in two. Several flags were deprecated and replaced with clearer options, but remarkably only two technically breaking changes resulted from ~2 weeks of work.

BREAKING CHANGE:

--preid now defaults to "alpha" during prereleases:

The previous default for this option was undefined, which led to an awkward "1.0.1-0" result when passed to semver.inc().

The new default "alpha" yields a much more useful "1.0.1-alpha.0" result. Any previous prerelease ID will be preserved, just as it was before.
--no-verify is no longer passed to git commit by default, but controlled by the new --commit-hooks option:

The previous behavior was too overzealous, and the new option operates exactly like the corresponding npm version option of the same name.

As long as your pre-commit hooks are properly scoped to ignore changes in package.json files, this change should not affect you. If that is not the case, you may pass --no-commit-hooks to restore the previous behavior.

Motivation and Context

Fixes #277
Fixes #936
Fixes #956
Fixes #961
Fixes #1056
Fixes #1118
Fixes #1385
Fixes #1483
Fixes #1494

This PR lays the groundwork for #1091 (and #1513) by making lerna publish only directly worrying about publish itself, not all those other complicated versioning decisions.

How Has This Been Tested?

Ported unit tests, with "full-bleed" integration tests of npm publish thanks to the new --dry-run flag in npm@6.

Types of changes

New feature (non-breaking change which adds functionality)
Breaking change (internal tools)

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.

* share composed options more cleanly with publish + changed * add version lib mocks to unblock non-canary publish tests * handle early return from version command * Use inline snapshots for canary tests, adding sequential cases * integration/publish: remove --skip-git, --skip-npm, --cd-version flags * integration/publish: pass --dry-run via env var

…nstance methods

… it again in needsBump()

BREAKING CHANGE: The previous default for `--preid` was undefined, which led to an awkward "1.0.1-0" result. It will now default to "alpha", which yields a more useful "1.0.1-alpha.0" result. Any previous prerelease ID will be preserved, just as it was before.

fenduru · 2018-07-26T22:26:02Z

integration/__snapshots__/lerna-publish.test.js.snap

- - package-5: 1.0.0 => 1.1.0-alpha.SHA (private)
-
+Successfully published:
+ - package-1@1.0.1-alpha.0+SHA


Out of curiosity what's the benefit of -alpha.0+SHA vs -alpha+SHA

This solves most of #277, allowing ^ ranges of canary prereleases to evaluate correctly. Without the .0 after the prerelease id, semver attempts to parse the git SHA as a number, which leads to very erratic behavior as SHAs are not guaranteed to start with a number, etc.

https://semver.npmjs.com/ is a good playground to demonstrate this. Try it with lerna at range ^3.0.0-beta.10, and you'll notice 3.0.0-beta.9 isn't highlighted:

Semver ignores anything after the +, hence stashing the SHA there. It's meant to dedupe the tarball when attempting to upload, since there might be multiple foo-pkg@1.0.1-beta.4 (with different +SHA values) published. (This is why it's a good idea to use --exact with --canary when you're dealing with contentious feature branch publishes)

morgs32 · 2018-07-29T14:37:26Z

@evocateur I salute you this looks so promising. I am curious about the bit of documentation that strongly discourages running lerna version from a branch. I kind of figured that I'd manually be incrementing versions on a branch and in a PR, and then on merge to master I'd lerna publish from-git. But is that not a wise idea? What sort of process would you suggest or what did you have in mind?

(This part added later) Actually, I think your documentation is sufficient I just had to read it a couple times. Do think doing this in GitHub on my monorepo would remove the concern?

evocateur · 2018-07-29T15:30:43Z

@morgs32 My biggest concern with making tagged releases in feature branches is that the tags get mangled when merging.

I'm not sure if rebase merge would be any safer, since if it was rebasing onto upstream commits, the SHAs would change and thus the annotated tag(s) would be "broken", as the SHA it points to no longer exists. However, I haven't tried rebase merge in a long time, and I don't recall if git rebase itself preserves tags.

One of my goals in the near future is to improve the "auto-publish from CI" experience, perhaps with a subcommand lerna publish release. I envision some configurable branch awareness that would publish untagged prereleases on feature branches (or PRs only?) and then on master (or latest, whatever your "default" branch is configured to be) it would publish with tags, even creating github releases with changelogs (if you're using conventional commits).

So please let me know if lerna publish from-git works after a rebase merge, I would like to figure this out, even if it is "just" a clarification to the documentation!

danielo515 · 2018-08-12T12:11:34Z

commands/version/README.md

+```json
+{
+  "command": {
+    "publish": {


Is this correct @evocateur ? Do you configure lerna version by configuring publish on lerna.json ? Seems confusing

evocateur · 2018-08-12T14:46:55Z

It's for backward-compatibility. The `lerna version` docs probably should be updated to use the correct namespace, though.

…

On Aug 12, 2018, at 05:11, Daniel Rodríguez Rivero ***@***.***> wrote: Do you configure lerna version by configuring publish on lerna.json ? Seems confusing

BREAKING CHANGE: * `--preid` now defaults to "alpha" during prereleases: The previous default for this option was undefined, which led to an awkward "1.0.1-0" result when passed to `semver.inc()`. The new default "alpha" yields a much more useful "1.0.1-alpha.0" result. Any previous prerelease ID will be preserved, just as it was before. * `--no-verify` is no longer passed to `git commit` by default, but controlled by the new `--commit-hooks` option: The previous behavior was too overzealous, and the new option operates exactly like the corresponding [npm version](https://docs.npmjs.com/cli/version#commit-hooks) option of the same name. As long as your pre-commit hooks are properly scoped to ignore changes in package.json files, this change should not affect you. If that is not the case, you may pass `--no-commit-hooks` to restore the previous behavior. Fixes lerna#277 Fixes lerna#936 Fixes lerna#956 Fixes lerna#961 Fixes lerna#1056 Fixes lerna#1118 Fixes lerna#1385 Fixes lerna#1483 Fixes lerna#1494

lock · 2018-12-27T03:25:14Z

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.

evocateur added 4 commits July 25, 2018 17:16

refactor(version): Extract .promptVersion() -> lib/prompt-version

0d167ad

refactor(version): Extract fixed chain of .recommendVersions() into i…

a069563

…nstance methods

refactor(version): define update mapper + tasks separately

915291e

evocateur force-pushed the split-version-from-publish branch from 362a9e4 to 915291e Compare July 26, 2018 00:16

evocateur added 6 commits July 25, 2018 17:21

chore: fix typo

93049e4

fix: cdVersion -> bump

f51a31c

feat(package-graph): Add prereleaseId property to nodes

f1a76ad

refactor(collect-updates): Use node.prereleaseId instead of computing…

20fdc9b

… it again in needsBump()

fix(publish): Remove unused dependencies

2c1bd40

hutson mentioned this pull request Jul 26, 2018

fix(publish): move git sha to build metadata #1507

Closed

9 tasks

evocateur added 6 commits July 26, 2018 11:03

chore: publishing -> versioning in flavor text

c6d48c9

refactor(version): --push-to-remote => --push, it's cleaner

6da6fd6

fix(version): backward-compatible --cd-version

40afdae

fix(version): backward-compatible --repo-version

912a929

fix(version): backward-compatible --skip-git

a5013ab

fix(version): backward-compatible --skip-npm

647dfbb

fenduru reviewed Jul 26, 2018

View reviewed changes

docs: finish em [skip ci]

a52bd8c

evocateur merged commit 8b97394 into lerna:master Jul 27, 2018

evocateur deleted the split-version-from-publish branch July 27, 2018 17:13

evocateur mentioned this pull request Aug 8, 2018

Option to remove "v" from the git tag #1399

Closed

danielo515 reviewed Aug 12, 2018

View reviewed changes

edmorley mentioned this pull request Aug 15, 2018

Update dependency lerna to v3 neutrinojs/neutrino#1023

Closed

evocateur mentioned this pull request Sep 3, 2018

Lerna version canary support #1583

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

feat: Split `lerna version` from of `lerna publish` #1522

feat: Split `lerna version` from of `lerna publish` #1522

evocateur commented Jul 26, 2018 •

edited

fenduru Jul 26, 2018

evocateur Jul 26, 2018

morgs32 commented Jul 29, 2018 •

edited

evocateur commented Jul 29, 2018

danielo515 Aug 12, 2018

evocateur commented Aug 12, 2018 via email

lock bot commented Dec 27, 2018

feat: Split lerna version from of lerna publish #1522

feat: Split lerna version from of lerna publish #1522

Conversation

evocateur commented Jul 26, 2018 • edited

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

fenduru Jul 26, 2018

Choose a reason for hiding this comment

evocateur Jul 26, 2018

Choose a reason for hiding this comment

morgs32 commented Jul 29, 2018 • edited

evocateur commented Jul 29, 2018

danielo515 Aug 12, 2018

Choose a reason for hiding this comment

evocateur commented Aug 12, 2018 via email

lock bot commented Dec 27, 2018

feat: Split `lerna version` from of `lerna publish` #1522

feat: Split `lerna version` from of `lerna publish` #1522

evocateur commented Jul 26, 2018 •

edited

morgs32 commented Jul 29, 2018 •

edited