fix: allow opt-out of Fixes/Refs metadata (#474)

* fix: allow opt-out of Fixes/Refs metadata

* Add metadata gen test

components/git/land.js

@@ -42,6 +42,11 @@ const landOptions = {
     describe: 'Land a backport PR onto a staging branch',
     default: false,
     type: 'boolean'
+  },
+  skipRefs: {
+    describe: 'Prevent adding Fixes and Refs information to commit metadata',
+    default: false,
+    type: 'boolean'
   }
 };
 
@@ -89,7 +94,8 @@ function handler(argv) {
 
   const provided = [];
   for (const type of Object.keys(landOptions)) {
-    if (type === 'yes') continue;  // --yes is not an action
+    // --yes and --skipRefs are not actions.
+    if (type === 'yes' || type === 'skipRefs') continue;
     if (argv[type]) {
       provided.push(type);
     }
@@ -160,7 +166,7 @@ async function main(state, argv, cli, req, dir) {
       return;
     }
     session = new LandingSession(cli, req, dir, argv.prid, argv.backport);
-    const metadata = await getMetadata(session.argv, cli);
+    const metadata = await getMetadata(session.argv, argv.skipRefs, cli);
     if (argv.backport) {
       const split = metadata.metadata.split('\n')[0];
       if (split === 'PR-URL: ') {

components/metadata.js

@@ -9,7 +9,7 @@ const MetadataGenerator = require('../lib/metadata_gen');
 
 const fs = require('fs');
 
-module.exports = async function getMetadata(argv, cli) {
+module.exports = async function getMetadata(argv, skipRefs, cli) {
   const credentials = await auth({
     github: true,
     jenkins: true
@@ -23,7 +23,7 @@ module.exports = async function getMetadata(argv, cli) {
   cli.separator('PR info');
   summary.display();
 
-  const metadata = new MetadataGenerator(data).getMetadata();
+  const metadata = new MetadataGenerator({ skipRefs, ...data }).getMetadata();
   if (!process.stdout.isTTY) {
     process.stdout.write(metadata);
   }

docs/git-node.md

@@ -47,6 +47,8 @@ Options:
                   non-interactively. If an undesirable situation occurs, such as
                   a pull request or commit check fails, then git node land will
                   abort.                              [boolean] [default: false]
+  --skipRefs      Prevent Fixes and Refs information from being added to commit
+                  metadata                            [boolean] [default: false]
 
 
 Examples:

lib/metadata_gen.js

@@ -10,8 +10,9 @@ class MetadataGenerator {
    * @param {PRData} data
    */
   constructor(data) {
-    const { owner, repo, pr, reviewers, argv } = data;
+    const { owner, repo, pr, reviewers, argv, skipRefs } = data;
     this.owner = owner;
+    this.skipRefs = skipRefs;
     this.repo = repo;
     this.pr = pr;
     this.reviewers = reviewers;
@@ -33,10 +34,17 @@ class MetadataGenerator {
     const fixes = parser.getFixes();
     const refs = parser.getRefs();
     const altPrUrl = parser.getAltPrUrl();
-    const meta = [
-      ...fixes.map((fix) => `Fixes: ${fix}`),
-      ...refs.map((ref) => `Refs: ${ref}`)
-    ];
+
+    const meta = [];
+
+    // If there are multiple commits in a PR, we may not want to add
+    // Fixes/Refs metadata to all of them.
+    if (!this.skipRefs) {
+      // Map all issues fixed by the commit(s) in this PR.
+      meta.push(...fixes.map((fix) => `Fixes: ${fix}`));
+      // Map all issues referenced by the commit(s) in this PR.
+      meta.push(...refs.map((ref) => `Refs: ${ref}`));
+    }
     const backport = this.argv ? this.argv.backport : undefined;
     if (backport) {
       meta.unshift(`Backport-PR-URL: ${prUrl}`);

test/unit/metadata_gen.test.js

@@ -52,6 +52,12 @@ Backport-PR-URL: https://github.com/nodejs/node/pull/30072
 Fixes: https://github.com/nodejs/build/issues/1961
 Refs: https://github.com/nodejs/node/commit/53ca0b9ae145c430842bf78e553e3b6cbd2823aa#commitcomment-35494896
 `;
+const skipRefsExpected = `PR-URL: https://github.com/nodejs/node/pull/16438
+Reviewed-By: Foo User <foo@example.com>
+Reviewed-By: Quux User <quux@example.com>
+Reviewed-By: Baz User <baz@example.com>
+Reviewed-By: Bar User <bar@example.com>
+`;
 
 describe('MetadataGenerator', () => {
   it('should generate metadata properly', () => {
@@ -68,4 +74,10 @@ describe('MetadataGenerator', () => {
     const backportResults = new MetadataGenerator(backportData).getMetadata();
     assert.strictEqual(backportExpected, backportResults);
   });
+
+  it('should skip adding Fixes/Refs metadata when --skipRefs is passed', () => {
+    const data = { skipRefs: true, ...crossData };
+    const backportResults = new MetadataGenerator(data).getMetadata();
+    assert.strictEqual(skipRefsExpected, backportResults);
+  });
 });