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

feat(npm): use version commit message from lerna.json #2277

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
86 changes: 86 additions & 0 deletions plugins/npm/__tests__/npm.test.ts
Expand Up @@ -880,6 +880,92 @@ describe("publish", () => {
]);
});

test("monorepo - should use commit message from lerna.json", async () => {
mockFs({
"lerna.json": `
{
"command": {
"version": {
"message": "[skip ci] Custom version commit message"
}
}
}
`,
...monorepoPackagesOnFs,
});

const plugin = new NPMPlugin();
const hooks = makeHooks();

plugin.apply({
config: { prereleaseBranches: ["next"] },
hooks,
remote: "origin",
baseBranch: "main",
logger: dummyLog(),
} as Auto.Auto);

monorepoPackages.mockReturnValueOnce(monorepoPackagesResult);
execPromise.mockReturnValueOnce("1.0.0");

await hooks.version.promise({ bump: Auto.SEMVER.patch });
expect(execPromise).toHaveBeenNthCalledWith(2, "npx", [
"lerna",
"version",
"1.0.1",
"--force-publish",
"--no-commit-hooks",
"--yes",
"--no-push",
"-m",
"'\"[skip ci] Custom version commit message\"'",
false,
]);
});

test("monorepo - should ensure commit message from lerna.json contains [skip ci]", async () => {
mockFs({
"lerna.json": `
{
"command": {
"version": {
"message": "Custom version commit message"
}
}
}
`,
...monorepoPackagesOnFs,
});

const plugin = new NPMPlugin();
const hooks = makeHooks();

plugin.apply({
config: { prereleaseBranches: ["next"] },
hooks,
remote: "origin",
baseBranch: "main",
logger: dummyLog(),
} as Auto.Auto);

monorepoPackages.mockReturnValueOnce(monorepoPackagesResult);
execPromise.mockReturnValueOnce("1.0.0");

await hooks.version.promise({ bump: Auto.SEMVER.patch });
expect(execPromise).toHaveBeenNthCalledWith(2, "npx", [
"lerna",
"version",
"1.0.1",
"--force-publish",
"--no-commit-hooks",
"--yes",
"--no-push",
"-m",
"'\"Custom version commit message [skip ci]\"'",
false,
]);
});

test("should publish private scoped packages to private", async () => {
const plugin = new NPMPlugin();
const hooks = makeHooks();
Expand Down
21 changes: 17 additions & 4 deletions plugins/npm/src/index.ts
Expand Up @@ -958,7 +958,8 @@ export default class NPMPlugin implements IPlugin {

if (isMonorepo()) {
auto.logger.verbose.info("Detected monorepo, using lerna");
const monorepoVersion = getLernaJson().version;
const lernaJson = getLernaJson();
const monorepoVersion = lernaJson.version;
const isIndependent = monorepoVersion === "independent";

if (dryRun) {
Expand Down Expand Up @@ -995,6 +996,20 @@ export default class NPMPlugin implements IPlugin {
? useVersion || bump
: useVersion || (await bumpLatest(getMonorepoPackage(), bump)) || bump;

let commitMessage = isIndependent
? "Bump independent versions [skip ci]"
: "Bump version to: %s [skip ci]";

const customCommitMessage = lernaJson.command?.version?.message;

if (typeof customCommitMessage === "string") {
commitMessage = customCommitMessage.trim();

if (customCommitMessage.indexOf("[skip ci]") === -1) {
commitMessage += " [skip ci]";
}
}

await execPromise("npx", [
"lerna",
"version",
Expand All @@ -1004,9 +1019,7 @@ export default class NPMPlugin implements IPlugin {
"--yes",
"--no-push",
"-m",
isIndependent
? `'"Bump independent versions [skip ci]"'`
: `'"Bump version to: %s [skip ci]"'`,
`'"${commitMessage}"'`,
UncleDave marked this conversation as resolved.
Show resolved Hide resolved
this.exact && "--exact",
...verboseArgs,
]);
Expand Down