feat: Add signoff option (#120)

* chore(release): 13.0.0

* feat: added support for git commit --signoff

Signed-off-by: mbwhite <whitemat@uk.ibm.com>

---------

Signed-off-by: mbwhite <whitemat@uk.ibm.com>

Author: mbwhite

README.md

@@ -279,6 +279,10 @@ commit-and-tag-version --no-verify
 
 If you have your GPG key set up, add the `--sign` or `-s` flag to your `commit-and-tag-version` command.
 
+### Signed-off-by trailer
+
+To add the "Signed-off-by" trailer to the commit message add the `--signoff` flag to your `commit-and-tag-version` command.
+
 ### Lifecycle Scripts
 
 `commit-and-tag-version` supports lifecycle scripts. These allow you to execute your

command.js

@@ -48,6 +48,11 @@ const yargs = require('yargs')
     type: 'boolean',
     default: defaults.sign,
   })
+  .option('signoff', {
+    describe: 'Should the git commit have a "Signed-off-by" trailer',
+    type: 'boolean',
+    default: defaults.signoff,
+  })
   .option('no-verify', {
     alias: 'n',
     describe:

defaults.js

@@ -4,6 +4,7 @@ const defaults = {
   infile: 'CHANGELOG.md',
   firstRelease: false,
   sign: false,
+  signoff: false,
   noVerify: false,
   commitAll: false,
   silent: false,

lib/lifecycles/commit.js

@@ -18,6 +18,7 @@ async function execCommit(args, newVersion) {
   let paths = [];
   const verify = args.verify === false || args.n ? ['--no-verify'] : [];
   const sign = args.sign ? ['-S'] : [];
+  const signoff = args.signoff ? ['--signoff'] : [];
   const toAdd = [];
 
   // only start with a pre-populated paths list when CHANGELOG processing is not skipped
@@ -59,7 +60,7 @@ async function execCommit(args, newVersion) {
   await runExecFile(
     args,
     'git',
-    ['commit'].concat(verify, sign, args.commitAll ? [] : toAdd, [
+    ['commit'].concat(verify, sign, signoff, args.commitAll ? [] : toAdd, [
       '-m',
       `${formatCommitMessage(args.releaseCommitMessageFormat, newVersion)}`,
     ]),

package-lock.json

@@ -1475,6 +1475,42 @@ describe('cli', function () {
       expect(gitArgs).toHaveLength(0);
     });
 
+    it('--signedoff adds signed-off-by to the commit message', async function () {
+      const gitArgs = [
+        ['add', 'CHANGELOG.md', 'package.json', 'package-lock.json'],
+        [
+          'commit',
+          '--signoff',
+          'CHANGELOG.md',
+          'package.json',
+          'package-lock.json',
+          '-m',
+          'chore(release): 1.0.1',
+        ],
+        ['tag', '-a', 'v1.0.1', '-m', 'chore(release): 1.0.1'],
+        ['rev-parse', '--abbrev-ref', 'HEAD'],
+      ];
+
+      runExecFile.mockImplementation((_args, cmd, cmdArgs) => {
+        expect(cmd).toEqual('git');
+
+        const expected = gitArgs.shift();
+        expect(cmdArgs).toEqual(expected);
+
+        if (expected[0] === 'rev-parse') return Promise.resolve('master');
+
+        return Promise.resolve('');
+      });
+
+      mock({
+        bump: 'patch',
+        changelog: 'foo\n',
+      });
+
+      await exec('--signoff', true);
+      expect(gitArgs).toHaveLength(0);
+    });
+
     it('--tag-force forces tag replacement', async function () {
       const gitArgs = [
         ['add', 'CHANGELOG.md', 'package.json', 'package-lock.json'],