feat(github-actions): automatically apply the target: feature label for pull requests targeting non-releasable branches (#2852)

Closes #2851

PR Close #2852

Author: josephperrott

github-actions/pull-request-labeling/lib/main.ts

@@ -1,11 +1,16 @@
 import * as core from '@actions/core';
 import {context} from '@actions/github';
-import {Octokit} from '@octokit/rest';
+import {Octokit, RestEndpointMethodTypes} from '@octokit/rest';
 import {Commit, parseCommitMessage} from '../../../ng-dev/commit-message/parse.js';
-import {managedLabels} from '../../../ng-dev/pr/common/labels/index.js';
+import {managedLabels, targetLabels} from '../../../ng-dev/pr/common/labels/index.js';
 import {ANGULAR_ROBOT, getAuthTokenFor, revokeActiveInstallationToken} from '../../utils.js';
 import {ManagedRepositories} from '../../../ng-dev/pr/common/labels/base.js';
 
+/** The type of the response data for a the pull request get method on from octokit. */
+type PullRequestGetData = RestEndpointMethodTypes['pulls']['get']['response']['data'];
+/** A Regex matcher to match releasable branch patterns. */
+const releasableBranchMatcher = /(main|\d+\.\d+\.x)/;
+
 class PullRequestLabeling {
   /** Run the commit message based labelling process. */
   static run = async () => {
@@ -26,6 +31,8 @@ class PullRequestLabeling {
   labels = new Set<string>();
   /** All commits in the PR */
   commits: Commit[] = [];
+  /** The pull request information from the github API. */
+  pullRequestMetadata?: PullRequestGetData;
 
   private constructor(private git: Octokit) {}
 
@@ -35,6 +42,14 @@ class PullRequestLabeling {
     await this.initialize();
     core.info(`PR #${context.issue.number}`);
 
+    await this.commitMessageBasedLabeling();
+    await this.pullRequestMetadataLabeling();
+  }
+
+  /**
+   * Perform labeling based on the commit messages for the pull request.
+   */
+  async commitMessageBasedLabeling() {
     // Add or Remove label as appropriate for each of the supported label and commit messaage
     // combinations.
     for (const {commitCheck, name, repositories} of Object.values(managedLabels)) {
@@ -62,6 +77,31 @@ class PullRequestLabeling {
     }
   }
 
+  /**
+   * Perform labeling based on the metadata for the pull request from the Github API.
+   */
+  async pullRequestMetadataLabeling() {
+    // If we are unable to get pull request metadata, we can shortcut and exit early.
+    if (this.pullRequestMetadata === undefined) {
+      return;
+    }
+    /** The base reference string, or target branch of the pull request. */
+    const baseRef = this.pullRequestMetadata.base.ref;
+
+    if (!releasableBranchMatcher.test(baseRef)) {
+      if (this.labels.has(targetLabels.TARGET_FEATURE.name)) {
+        core.info(
+          `The target branch (${baseRef}) is not a releasable branch, already has "target: feature" label`,
+        );
+      } else {
+        core.info(
+          `The target branch (${baseRef}) is not a releasable branch, adding "target: feature" label`,
+        );
+        await this.addLabel(targetLabels.TARGET_FEATURE.name);
+      }
+    }
+  }
+
   /** Add the provided label to the pull request. */
   async addLabel(label: string) {
     const {number: issue_number, owner, repo} = context.issue;
@@ -97,6 +137,10 @@ class PullRequestLabeling {
     await this.git.issues
       .listLabelsOnIssue({issue_number: number, owner, repo})
       .then((resp) => resp.data.forEach(({name}) => this.labels.add(name)));
+
+    await this.git.pulls.get({owner, repo, pull_number: number}).then(({data}) => {
+      this.pullRequestMetadata = data;
+    });
   }
 }
 

github-actions/pull-request-labeling/main.js

@@ -43411,6 +43411,7 @@ async function revokeActiveInstallationToken(githubOrToken) {
 
 // 
 var _a;
+var releasableBranchMatcher = /(main|\d+\.\d+\.x)/;
 var PullRequestLabeling = class {
   constructor(git) {
     this.git = git;
@@ -43421,6 +43422,10 @@ var PullRequestLabeling = class {
   async run() {
     await this.initialize();
     core.info(`PR #${import_github2.context.issue.number}`);
+    await this.commitMessageBasedLabeling();
+    await this.pullRequestMetadataLabeling();
+  }
+  async commitMessageBasedLabeling() {
     for (const { commitCheck, name, repositories } of Object.values(managedLabels)) {
       if (!repositories.includes(import_github2.context.repo.repo)) {
         continue;
@@ -43439,6 +43444,20 @@ var PullRequestLabeling = class {
       }
     }
   }
+  async pullRequestMetadataLabeling() {
+    if (this.pullRequestMetadata === void 0) {
+      return;
+    }
+    const baseRef = this.pullRequestMetadata.base.ref;
+    if (!releasableBranchMatcher.test(baseRef)) {
+      if (this.labels.has(targetLabels.TARGET_FEATURE.name)) {
+        core.info(`The target branch (${baseRef}) is not a releasable branch, already has "target: feature" label`);
+      } else {
+        core.info(`The target branch (${baseRef}) is not a releasable branch, adding "target: feature" label`);
+        await this.addLabel(targetLabels.TARGET_FEATURE.name);
+      }
+    }
+  }
   async addLabel(label) {
     const { number: issue_number, owner, repo } = import_github2.context.issue;
     try {
@@ -43455,6 +43474,9 @@ var PullRequestLabeling = class {
     await this.git.paginate(this.git.issues.listLabelsForRepo, { owner, repo }).then((labels) => labels.filter((l) => l.name.startsWith("area: ")).forEach((l) => this.repoAreaLabels.add(l.name)));
     await this.git.paginate(this.git.pulls.listCommits, { owner, pull_number: number, repo }).then((commits) => this.commits = commits.map(({ commit }) => parseCommitMessage(commit.message)));
     await this.git.issues.listLabelsOnIssue({ issue_number: number, owner, repo }).then((resp) => resp.data.forEach(({ name }) => this.labels.add(name)));
+    await this.git.pulls.get({ owner, repo, pull_number: number }).then(({ data }) => {
+      this.pullRequestMetadata = data;
+    });
   }
 };
 _a = PullRequestLabeling;