feat: tagging the release also comments on the release PR (googleapis#751)

Author: chingor13

__snapshots__/github.js

@@ -128,6 +128,12 @@ export class GitHubRelease {
     );
     checkpoint(`Created release: ${release.html_url}.`, CheckpointType.Success);
 
+    // Comment on the release PR with the
+    await this.gh.commentOnIssue(
+      `:robot: Release is at ${release.html_url} :sunflower:`,
+      candidate.pullNumber
+    );
+
     // 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);

src/github-release.ts

@@ -39,8 +39,8 @@ type GitGetTreeResponse = PromiseValue<
 type IssuesListResponseItem = PromiseValue<
   ReturnType<InstanceType<typeof Octokit>['issues']['get']>
 >['data'];
-type FileSearchResponse = PromiseValue<
-  ReturnType<InstanceType<typeof Octokit>['search']['code']>
+type CreateIssueCommentResponse = PromiseValue<
+  ReturnType<InstanceType<typeof Octokit>['issues']['create']>
 >['data'];
 // see: PromiseValue<
 //  ReturnType<InstanceType<typeof Octokit>['repos']['createRelease']>
@@ -1404,6 +1404,33 @@ export class GitHub {
       prefix
     );
   }
+
+  /**
+   * Makes a comment on a issue/pull request.
+   *
+   * @param {string} comment - The body of the comment to post.
+   * @param {number} number - The issue or pull request number.
+   */
+  async commentOnIssue(
+    comment: string,
+    number: number
+  ): Promise<CreateIssueCommentResponse> {
+    checkpoint(
+      `adding comment to https://github.com/${this.owner}/${this.repo}/issue/${number}`,
+      CheckpointType.Success
+    );
+    return (
+      await this.request(
+        'POST /repos/:owner/:repo/issues/:issue_number/comments',
+        {
+          owner: this.owner,
+          repo: this.repo,
+          issue_number: number,
+          body: comment,
+        }
+      )
+    ).data;
+  }
 }
 
 class AuthError extends Error {

src/github.ts

@@ -0,0 +1,31 @@
+{
+  "id": 1,
+  "node_id": "MDEyOklzc3VlQ29tbWVudDE=",
+  "url": "https://api.github.com/repos/fake/fake/issues/comments/1",
+  "html_url": "https://github.com/fake/fake/issues/1347#issuecomment-1",
+  "body": "This is a comment",
+  "user": {
+    "login": "octocat",
+    "id": 1,
+    "node_id": "MDQ6VXNlcjE=",
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/octocat",
+    "html_url": "https://github.com/octocat",
+    "followers_url": "https://api.github.com/users/octocat/followers",
+    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+    "organizations_url": "https://api.github.com/users/octocat/orgs",
+    "repos_url": "https://api.github.com/users/octocat/repos",
+    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/octocat/received_events",
+    "type": "User",
+    "site_admin": false
+  },
+  "created_at": "2011-04-14T16:00:49Z",
+  "updated_at": "2011-04-14T16:00:49Z",
+  "issue_url": "https://api.github.com/repos/fake/fake/issues/1347",
+  "author_association": "COLLABORATOR"
+}

test/fixtures/create-comment-response.json

@@ -76,6 +76,11 @@ describe('GitHubRelease', () => {
           upload_url: 'https://upload.url/',
         });
 
+      sandbox
+        .stub(release.gh, 'commentOnIssue')
+        .withArgs(':robot: Release is at https://release.url :sunflower:', 1)
+        .resolves();
+
       sandbox
         .stub(release.gh, 'addLabels')
         .withArgs(['autorelease: tagged'], 1)
@@ -132,6 +137,11 @@ describe('GitHubRelease', () => {
           upload_url: 'https://upload.url/',
         });
 
+      sandbox
+        .stub(release.gh, 'commentOnIssue')
+        .withArgs(':robot: Release is at https://release.url :sunflower:', 1)
+        .resolves();
+
       sandbox
         .stub(release.gh, 'addLabels')
         .withArgs(['autorelease: tagged'], 1)
@@ -191,6 +201,11 @@ describe('GitHubRelease', () => {
           upload_url: 'https://upload.url/',
         });
 
+      sandbox
+        .stub(release.gh, 'commentOnIssue')
+        .withArgs(':robot: Release is at https://release.url :sunflower:', 1)
+        .resolves();
+
       sandbox
         .stub(release.gh, 'addLabels')
         .withArgs(['autorelease: tagged'], 1)
@@ -250,6 +265,11 @@ describe('GitHubRelease', () => {
           upload_url: 'https://upload.url/',
         });
 
+      sandbox
+        .stub(release.gh, 'commentOnIssue')
+        .withArgs(':robot: Release is at https://release.url :sunflower:', 1)
+        .resolves();
+
       sandbox
         .stub(release.gh, 'addLabels')
         .withArgs(['autorelease: tagged'], 1)
@@ -310,6 +330,11 @@ describe('GitHubRelease', () => {
           upload_url: 'https://upload.url/',
         });
 
+      sandbox
+        .stub(release.gh, 'commentOnIssue')
+        .withArgs(':robot: Release is at https://release.url :sunflower:', 1)
+        .resolves();
+
       sandbox
         .stub(release.gh, 'addLabels')
         .withArgs(['autorelease: tagged'], 1)
@@ -371,6 +396,11 @@ describe('GitHubRelease', () => {
           upload_url: 'https://upload.url/',
         });
 
+      sandbox
+        .stub(release.gh, 'commentOnIssue')
+        .withArgs(':robot: Release is at https://release.url :sunflower:', 1)
+        .resolves();
+
       sandbox
         .stub(release.gh, 'addLabels')
         .withArgs(['autorelease: tagged'], 1)
@@ -489,6 +519,11 @@ describe('GitHubRelease', () => {
           upload_url: 'https://upload.url/',
         });
 
+      sandbox
+        .stub(release.gh, 'commentOnIssue')
+        .withArgs(':robot: Release is at https://release.url :sunflower:', 1)
+        .resolves();
+
       sandbox
         .stub(release.gh, 'addLabels')
         .withArgs(['autorelease: tagged'], 1)
@@ -546,6 +581,11 @@ describe('GitHubRelease', () => {
           upload_url: 'https://upload.url/',
         });
 
+      sandbox
+        .stub(release.gh, 'commentOnIssue')
+        .withArgs(':robot: Release is at https://release.url :sunflower:', 1)
+        .resolves();
+
       sandbox
         .stub(release.gh, 'addLabels')
         .withArgs(['autorelease: tagged'], 1)
@@ -675,6 +715,11 @@ describe('GitHubRelease', () => {
           upload_url: 'https://upload.url/',
         });
 
+      sandbox
+        .stub(release.gh, 'commentOnIssue')
+        .withArgs(':robot: Release is at https://release.url :sunflower:', 1)
+        .resolves();
+
       sandbox
         .stub(release.gh, 'addLabels')
         .withArgs(['autorelease: tagged'], 1)

test/github-release.ts

@@ -838,4 +838,36 @@ describe('GitHub', () => {
       expect(release!.draft).to.be.false;
     });
   });
+
+  describe('commentOnIssue', () => {
+    it('can create a comment', async () => {
+      const createCommentResponse = JSON.parse(
+        readFileSync(
+          resolve(fixturesPath, 'create-comment-response.json'),
+          'utf8'
+        )
+      );
+      req
+        .post('/repos/fake/fake/issues/1347/comments', body => {
+          snapshot(body);
+          return true;
+        })
+        .reply(201, createCommentResponse);
+      const comment = await github.commentOnIssue('This is a comment', 1347);
+      expect(comment.body).to.eql('This is a comment');
+    });
+
+    it('propagates error', async () => {
+      req.post('/repos/fake/fake/issues/1347/comments').reply(410, 'Gone');
+      let thrown = false;
+      try {
+        await github.commentOnIssue('This is a comment', 1347);
+        fail('should have thrown');
+      } catch (err) {
+        thrown = true;
+        expect(err.status).to.eql(410);
+      }
+      expect(thrown).to.be.true;
+    });
+  });
 });