Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(version): Add
--create-release=[gitlab|github] option (#2073)
Deprecates `--github-release`, replacing with `--create-release=github`
- Loading branch information
1 parent
b22345b
commit 4974b78
Showing
20 changed files
with
547 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| "use strict"; | ||
|
|
||
| const client = { | ||
| repos: { | ||
| createRelease: jest.fn(), | ||
| }, | ||
| }; | ||
|
|
||
| module.exports = () => client; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
120 changes: 120 additions & 0 deletions
120
commands/version/__tests__/version-gitlab-release.test.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| "use strict"; | ||
|
|
||
| // local modules _must_ be explicitly mocked | ||
| jest.mock("../lib/git-add"); | ||
| jest.mock("../lib/git-commit"); | ||
| jest.mock("../lib/git-push"); | ||
| jest.mock("../lib/git-tag"); | ||
| jest.mock("../lib/is-anything-committed"); | ||
| jest.mock("../lib/is-behind-upstream"); | ||
| jest.mock("../lib/remote-branch-exists"); | ||
|
|
||
| // mocked modules | ||
| const client = require("@lerna/gitlab-client")(); | ||
| const { recommendVersion } = require("@lerna/conventional-commits"); | ||
|
|
||
| // helpers | ||
| const initFixture = require("@lerna-test/init-fixture")(__dirname); | ||
|
|
||
| // test command | ||
| const lernaVersion = require("@lerna-test/command-runner")(require("../command")); | ||
|
|
||
| test("--create-release=gitlab does not create a release if --no-push is passed", async () => { | ||
| const cwd = await initFixture("independent"); | ||
|
|
||
| await lernaVersion(cwd)("--create-release=gitlab", "--conventional-commits", "--no-push"); | ||
|
|
||
| expect(client.repos.createRelease).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| test("--create-release=gitlab throws an error if --conventional-commits is not passed", async () => { | ||
| const cwd = await initFixture("independent"); | ||
|
|
||
| try { | ||
| await lernaVersion(cwd)("--create-release=gitlab"); | ||
| } catch (err) { | ||
| expect(err.message).toBe("To create a release, you must enable --conventional-commits"); | ||
| expect(client.repos.createRelease).not.toHaveBeenCalled(); | ||
| } | ||
|
|
||
| expect.hasAssertions(); | ||
| }); | ||
|
|
||
| test("--create-release=gitlab throws an error if --no-changelog also passed", async () => { | ||
| const cwd = await initFixture("independent"); | ||
|
|
||
| try { | ||
| await lernaVersion(cwd)("--create-release=gitlab", "--conventional-commits", "--no-changelog"); | ||
| } catch (err) { | ||
| expect(err.message).toBe("To create a release, you cannot pass --no-changelog"); | ||
| expect(client.repos.createRelease).not.toHaveBeenCalled(); | ||
| } | ||
|
|
||
| expect.hasAssertions(); | ||
| }); | ||
|
|
||
| test("--create-release=gitlab marks a version as a pre-release if it contains a valid part", async () => { | ||
| const cwd = await initFixture("normal"); | ||
|
|
||
| recommendVersion.mockResolvedValueOnce("2.0.0-alpha.1"); | ||
|
|
||
| await lernaVersion(cwd)("--create-release=gitlab", "--conventional-commits"); | ||
|
|
||
| expect(client.repos.createRelease).toHaveBeenCalledTimes(1); | ||
| expect(client.repos.createRelease).toHaveBeenCalledWith({ | ||
| owner: "lerna", | ||
| repo: "lerna", | ||
| tag_name: "v2.0.0-alpha.1", | ||
| name: "v2.0.0-alpha.1", | ||
| body: "normal", | ||
| draft: false, | ||
| prerelease: true, | ||
| }); | ||
| }); | ||
|
|
||
| test("--create-release=gitlab creates a release for every independent version", async () => { | ||
| const cwd = await initFixture("independent"); | ||
| const versionBumps = new Map([ | ||
| ["package-1", "1.0.1"], | ||
| ["package-2", "2.1.0"], | ||
| ["package-3", "4.0.0"], | ||
| ["package-4", "4.1.0"], | ||
| ["package-5", "5.0.1"], | ||
| ]); | ||
|
|
||
| versionBumps.forEach(bump => recommendVersion.mockResolvedValueOnce(bump)); | ||
|
|
||
| await lernaVersion(cwd)("--create-release=gitlab", "--conventional-commits"); | ||
|
|
||
| expect(client.repos.createRelease).toHaveBeenCalledTimes(5); | ||
| versionBumps.forEach((version, name) => { | ||
| expect(client.repos.createRelease).toHaveBeenCalledWith({ | ||
| owner: "lerna", | ||
| repo: "lerna", | ||
| tag_name: `${name}@${version}`, | ||
| name: `${name}@${version}`, | ||
| body: `${name} - ${version}`, | ||
| draft: false, | ||
| prerelease: false, | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| test("--create-release=gitlab creates a single fixed release", async () => { | ||
| const cwd = await initFixture("normal"); | ||
|
|
||
| recommendVersion.mockResolvedValueOnce("1.1.0"); | ||
|
|
||
| await lernaVersion(cwd)("--create-release=gitlab", "--conventional-commits"); | ||
|
|
||
| expect(client.repos.createRelease).toHaveBeenCalledTimes(1); | ||
| expect(client.repos.createRelease).toHaveBeenCalledWith({ | ||
| owner: "lerna", | ||
| repo: "lerna", | ||
| tag_name: "v1.1.0", | ||
| name: "v1.1.0", | ||
| body: "normal", | ||
| draft: false, | ||
| prerelease: false, | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| "use strict"; | ||
|
|
||
| const semver = require("semver"); | ||
|
|
||
| const createGitLabClient = require("@lerna/gitlab-client"); | ||
| const { createGitHubClient, parseGitRepo } = require("@lerna/github-client"); | ||
| const ValidationError = require("@lerna/validation-error"); | ||
|
|
||
| module.exports = createRelease; | ||
|
|
||
| function createClient(type) { | ||
| switch (type) { | ||
| case "gitlab": | ||
| return createGitLabClient(); | ||
| case "github": | ||
| return createGitHubClient(); | ||
| default: | ||
| throw new ValidationError("ERELEASE", "Invalid release client type"); | ||
| } | ||
| } | ||
|
|
||
| function createRelease(type, { tags, releaseNotes }, { gitRemote, execOpts }) { | ||
| const repo = parseGitRepo(gitRemote, execOpts); | ||
| const client = createClient(type); | ||
|
|
||
| return Promise.all( | ||
| releaseNotes.map(({ notes, name }) => { | ||
| const tag = name === "fixed" ? tags[0] : tags.find(t => t.startsWith(`${name}@`)); | ||
|
|
||
| /* istanbul ignore if */ | ||
| if (!tag) { | ||
| return Promise.resolve(); | ||
| } | ||
|
|
||
| const prereleaseParts = semver.prerelease(tag.replace(`${name}@`, "")) || []; | ||
|
|
||
| return client.repos.createRelease({ | ||
| owner: repo.owner, | ||
| repo: repo.name, | ||
| tag_name: tag, | ||
| name: tag, | ||
| body: notes, | ||
| draft: false, | ||
| prerelease: prereleaseParts.length > 0, | ||
| }); | ||
| }) | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.