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(version): add --signoff git flag #2897

Merged
merged 2 commits into from Dec 13, 2022
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
11 changes: 9 additions & 2 deletions commands/version/README.md
Expand Up @@ -71,6 +71,7 @@ Running `lerna version --conventional-commits` without the above flags will rele
- [`--no-private`](#--no-private)
- [`--no-push`](#--no-push)
- [`--preid`](#--preid)
- [`--signoff-git-commit`](#--signoff-git-commit)
- [`--sign-git-commit`](#--sign-git-commit)
- [`--sign-git-tag`](#--sign-git-tag)
- [`--force-git-tag`](#--force-git-tag)
Expand Down Expand Up @@ -212,8 +213,8 @@ When run with this flag, `lerna version` will release with bumped prerelease ver

```sh
Changes:
- major: 1.0.0-alpha.0 => 2.0.0-alpha.0
- minor: 1.0.0-alpha.0 => 1.1.0-alpha.0
- major: 1.0.0-alpha.0 => 2.0.0-alpha.0
- minor: 1.0.0-alpha.0 => 1.1.0-alpha.0
- patch: 1.0.0-alpha.0 => 1.0.1-alpha.0
```

Expand Down Expand Up @@ -412,6 +413,12 @@ lerna version prepatch --preid next
When run with this flag, `lerna version` will increment `premajor`, `preminor`, `prepatch`, or `prerelease` semver
bumps using the specified [prerelease identifier](http://semver.org/#spec-item-9).

### `--signoff-git-commit`

Adds the `--signoff` flag to the git commit done by lerna version when executed.

> Note: This is different from `--sign-git-commit` which is about gpg signatures.

### `--sign-git-commit`

This option is analogous to the `npm version` [option](https://docs.npmjs.com/misc/config#sign-git-commit) of the same name.
Expand Down
6 changes: 6 additions & 0 deletions commands/version/__tests__/git-commit.test.js
Expand Up @@ -43,4 +43,10 @@ describe("git commit", () => {
await gitCommit("nice", { signGitCommit: true }, opts);
expect(childProcess.exec).toHaveBeenLastCalledWith("git", ["commit", "--gpg-sign", "-m", "nice"], opts);
});

test("--signoff-git-commit", async () => {
const opts = { cwd: "signed-off" };
await gitCommit("nice", { signoffGitCommit: true }, opts);
expect(childProcess.exec).toHaveBeenLastCalledWith("git", ["commit", "--signoff", "-m", "nice"], opts);
});
});
4 changes: 4 additions & 0 deletions commands/version/command.js
Expand Up @@ -150,6 +150,10 @@ exports.builder = (yargs, composed) => {
describe: "Pass the `--gpg-sign` flag to `git commit`.",
type: "boolean",
},
"signoff-git-commit": {
describe: "Pass the `--signoff` flag to `git commit`.",
type: "boolean",
},
"sign-git-tag": {
describe: "Pass the `--sign` flag to `git tag`.",
type: "boolean",
Expand Down
2 changes: 2 additions & 0 deletions commands/version/index.js
Expand Up @@ -68,6 +68,7 @@ class VersionCommand extends Command {
granularPathspec = true,
push = true,
signGitCommit,
signoffGitCommit,
signGitTag,
forceGitTag,
tagVersionPrefix = "v",
Expand Down Expand Up @@ -96,6 +97,7 @@ class VersionCommand extends Command {
commitHooks,
granularPathspec,
signGitCommit,
signoffGitCommit,
signGitTag,
forceGitTag,
};
Expand Down
6 changes: 5 additions & 1 deletion commands/version/lib/git-commit.js
Expand Up @@ -12,7 +12,7 @@ module.exports.gitCommit = gitCommit;
* @param {{ amend: boolean; commitHooks: boolean; signGitCommit: boolean; }} gitOpts
* @param {import("@lerna/child-process").ExecOpts} opts
*/
function gitCommit(message, { amend, commitHooks, signGitCommit }, opts) {
function gitCommit(message, { amend, commitHooks, signGitCommit, signoffGitCommit }, opts) {
log.silly("gitCommit", message);
const args = ["commit"];

Expand All @@ -24,6 +24,10 @@ function gitCommit(message, { amend, commitHooks, signGitCommit }, opts) {
args.push("--gpg-sign");
}

if (signoffGitCommit) {
args.push("--signoff");
}

if (amend) {
args.push("--amend", "--no-edit");
} else if (message.indexOf(EOL) > -1) {
Expand Down