feat: allow overriding release label (#900)

src/github-release.ts

@@ -39,11 +39,13 @@ export class GitHubRelease {
   releasePR: ReleasePR;
   gh: GitHub;
   draft: boolean;
+  releaseLabel: string;
 
   constructor(options: GitHubReleaseConstructorOptions) {
     this.draft = !!options.draft;
     this.gh = options.github;
     this.releasePR = options.releasePR;
+    this.releaseLabel = options.releaseLabel ?? GITHUB_RELEASE_LABEL;
   }
 
   async createRelease(): Promise<
@@ -107,7 +109,7 @@ export class GitHubRelease {
 
     // Add a label indicating that a release has been created on GitHub,
     // but a publication has not yet occurred.
-    await this.gh.addLabels([GITHUB_RELEASE_LABEL], candidate.pullNumber);
+    await this.gh.addLabels([this.releaseLabel], candidate.pullNumber);
     // Remove 'autorelease: pending' which indicates a GitHub release
     // has not yet been created.
     await this.gh.removeLabels(this.releasePR.labels, candidate.pullNumber);

src/index.ts

@@ -32,6 +32,7 @@ interface GitHubOptions {
 
 // Used by GitHubRelease: Factory and Constructor
 export interface GitHubReleaseOptions {
+  releaseLabel?: string;
   draft?: boolean;
 }
 

test/github-release.ts

@@ -17,7 +17,7 @@ import {describe, it, afterEach} from 'mocha';
 import {expect} from 'chai';
 import * as nock from 'nock';
 import * as crypto from 'crypto';
-import {strictEqual} from 'assert';
+import {strictEqual, ok} from 'assert';
 nock.disableNetConnect();
 
 import {GitHubRelease} from '../src/github-release';
@@ -79,7 +79,8 @@ describe('GitHubRelease', () => {
 
   function mockGithubLabelsAndComment(
     mock: sinon.SinonMock,
-    mockLabelsAndComment: boolean
+    mockLabelsAndComment: boolean,
+    releaseLabel = 'autorelease: tagged'
   ) {
     if (mockLabelsAndComment) {
       mock
@@ -92,7 +93,7 @@ describe('GitHubRelease', () => {
         .resolves();
       mock
         .expects('addLabels')
-        .withExactArgs(['autorelease: tagged'], 1)
+        .withExactArgs([releaseLabel], 1)
         .once()
         .resolves();
       mock
@@ -593,6 +594,37 @@ describe('GitHubRelease', () => {
       mock.verify();
       expect(created).to.be.undefined;
     });
+
+    it('supports overriding the release tag', async () => {
+      const github = new GitHub({owner: 'googleapis', repo: 'foo'});
+      const mock = mockGithubCommon({
+        github,
+        prHead: 'release-v1.0.3',
+        prTitle: 'Release v1.0.3',
+      });
+      mockGithubLabelsAndComment(mock, true, 'custom-label');
+      mock
+        .expects('createRelease')
+        .withExactArgs('foo', 'v1.0.3', 'abc123', '\n* entry', false)
+        .once()
+        .resolves({
+          name: 'foo v1.0.3',
+          tag_name: 'v1.0.3',
+          html_url: 'https://release.url',
+          upload_url: 'https://upload.url/',
+          body: '\n* entry',
+        });
+
+      const releasePR = new ReleasePR({github, packageName: 'foo'});
+      const releaser = new GitHubRelease({
+        github,
+        releasePR,
+        releaseLabel: 'custom-label',
+      });
+      const created = await releaser.run();
+
+      ok(created);
+    });
   });
   describe('createRelease', () => {
     it('uses version for createRelease', async () => {