Fix #304: Add check for hotfix label (#305)

Co-authored-by: Vojtěch Jelínek <[email protected]>

Author: ankita240796

constants.js

@@ -37,6 +37,7 @@ const claCheckGithubAction = 'cla-check-github-action';
 const changelogCheck = 'changelog-check';
 const datastoreLabelCheck = 'datastore-label-check';
 const prLabelCheck = 'pr-label-check';
+const hotfixLabelCheck = 'hotfix-label-check';
 const prTemplateCheck = 'pr-template-check';
 // This check is required in re-open events as well to
 // prevent user from reopening the PR.
@@ -98,7 +99,7 @@ const checksWhitelist = {
       modelCheck,
       prTemplateCheck
     ],
-    [PRLabelEvent]: [assigneeCheck, prLabelCheck],
+    [PRLabelEvent]: [assigneeCheck, prLabelCheck, hotfixLabelCheck],
     [synchronizeEvent]: [
       mergeConflictCheck,
       jobCheck,
@@ -169,6 +170,7 @@ module.exports.issuesLabelCheck = issuesLabelCheck;
 module.exports.issuesAssignedCheck = issuesAssignedCheck;
 module.exports.datastoreLabelCheck = datastoreLabelCheck;
 module.exports.prLabelCheck = prLabelCheck;
+module.exports.hotfixLabelCheck = hotfixLabelCheck;
 module.exports.prTemplateCheck = prTemplateCheck;
 module.exports.forcePushCheck = forcePushCheck;
 module.exports.pullRequestReviewCheck = pullRequestReviewCheck;

index.js

@@ -110,6 +110,11 @@ const runChecks = async (context, checkEvent) => {
               checkPullRequestLabelsModule.checkForIssueLabel(context)
             );
             break;
+          case constants.hotfixLabelCheck:
+            callable.push(
+              checkPullRequestLabelsModule.checkHotfixLabel(context)
+            );
+            break;
           case constants.datastoreLabelCheck:
             callable.push(
               checkPullRequestLabelsModule.checkCriticalLabel(context)

lib/checkPullRequestLabels.js

@@ -18,6 +18,7 @@
 const {
   LABELS_EXCLUDED_FROM_CODEOWNER_ASSIGNMENT,
   DATASTORE_LABEL,
+  HOTFIX_LABEL,
   OLD_BUILD_LABEL,
   getProjectOwnerFromLabel,
   getChangelogLabelFromPullRequest,
@@ -340,6 +341,29 @@ module.exports.checkCriticalLabel = async function (context) {
   }
 };
 
+/**
+ * This function pings the release team if PR is labelled as required
+ * for hotfix.
+ *
+ * @param {import('probot').Context} context
+ */
+module.exports.checkHotfixLabel = async function (context) {
+  /**
+   * @type {import('probot').Octokit.IssuesGetLabelResponse} label
+   */
+  const label = context.payload.label;
+  if (label.name === HOTFIX_LABEL) {
+    var commentParams = context.issue({
+        body:
+          'Hi, @oppia/release-coordinators flagging this pull request for ' +
+          'for your attention since this is labelled as a hotfix PR. ' +
+          'Please ensure that you add the "PR: for current release" ' +
+          'label if the next release is in progress. Thanks!'
+      });
+    await context.github.issues.createComment(commentParams);
+  }
+};
+
 /**
  * This function checks if a label is allowed on Pull Requests.
  *

lib/utils.js

@@ -19,6 +19,7 @@
 const { 'default': Axios } = require('axios');
 
 const DATASTORE_LABEL = 'PR: Affects datastore layer';
+const HOTFIX_LABEL = 'PR: Needs to be hotfixed';
 // Labels here are excluded from codeowner assignment because the project
 // owners need to review all pull requests with the label.
 const LABELS_EXCLUDED_FROM_CODEOWNER_ASSIGNMENT = [
@@ -486,6 +487,7 @@ module.exports = {
   THREE_MINUTES,
   LABELS_EXCLUDED_FROM_CODEOWNER_ASSIGNMENT,
   DATASTORE_LABEL,
+  HOTFIX_LABEL,
   OLD_BUILD_LABEL,
   JOBS_AND_FETURES_TESTING_WIKI_LINK,
   getAllChangedFiles,

spec/checkPullRequestLabelsSpec.js

@@ -661,6 +661,41 @@ describe('Pull Request Label Check', () => {
     });
   });
 
+  describe('when hotfix label gets added', () => {
+    const label = {
+      id: 638839900,
+      node_id: 'MDU6TGFiZWw2Mzg4Mzk5MDA=',
+      url: 'https://api.github.com/repos/oppia/oppia/labels/PR:%20released',
+      name: 'PR: Needs to be hotfixed',
+      color: '00FF00',
+    };
+
+    beforeEach(async () => {
+      payloadData.payload.action = 'labeled';
+      payloadData.payload.label = label;
+      spyOn(checkPullRequestLabelModule, 'checkHotfixLabel').and.callThrough();
+      await robot.receive(payloadData);
+    });
+
+    it('should check for hotfix label', () => {
+      expect(checkPullRequestLabelModule.checkHotfixLabel).toHaveBeenCalled();
+    });
+
+    it('should comment on PR', () => {
+      expect(github.issues.createComment).toHaveBeenCalled();
+      expect(github.issues.createComment).toHaveBeenCalledWith({
+        body:
+          'Hi, @oppia/release-coordinators flagging this pull request for ' +
+          'for your attention since this is labelled as a hotfix PR. ' +
+          'Please ensure that you add the "PR: for current release" ' +
+          'label if the next release is in progress. Thanks!',
+        number: payloadData.payload.pull_request.number,
+        owner: payloadData.payload.repository.owner.login,
+        repo: payloadData.payload.repository.name
+      })
+    })
+  });
+
   describe('when another label gets removed', () => {
     const label = {
       id: 638839900,