feat(github-actions): ensure pull requests with deprecation commits have a deprecation label

.github/workflows/breaking-changes.yml → .github/workflows/commit-message-based-labels.yml

@@ -9,6 +9,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: ./github-actions/breaking-changes-label
+      - uses: ./github-actions/commit-message-based-labels
         with:
           angular-robot-key: ${{ secrets.ANGULAR_ROBOT_PRIVATE_KEY }}

.ng-dev/commit-message.ts

@@ -17,7 +17,7 @@ export const commitMessage: CommitMessageConfig = {
       'remote-execution',
     ]),
     ...buildScopesFor('github-actions', [
-      'breaking-changes-label',
+      'commit-message-based-labels',
       'feature-request',
       'lock-closed',
       'rebase',

.prettierignore

@@ -4,8 +4,8 @@ github-actions/feature-request/post.js
 github-actions/feature-request/main.js
 github-actions/lock-closed/main.js
 github-actions/lock-closed/post.js
-github-actions/breaking-changes-label/main.js
-github-actions/breaking-changes-label/post.js
+github-actions/commit-message-based-labels/main.js
+github-actions/commit-message-based-labels/post.js
 github-actions/slash-commands/main.js
 github-actions/slash-commands/post.js
 tools/local-actions/changelog/main.js

github-actions/commit-message-based-labels/BUILD.bazel

@@ -0,0 +1,19 @@
+load("//tools:defaults.bzl", "esbuild_checked_in")
+
+esbuild_checked_in(
+    name = "post",
+    entry_point = "//github-actions/commit-message-based-labels/lib:post.ts",
+    external = ["ts-node"],
+    deps = [
+        "//github-actions/commit-message-based-labels/lib",
+    ],
+)
+
+esbuild_checked_in(
+    name = "main",
+    entry_point = "//github-actions/commit-message-based-labels/lib:main.ts",
+    external = ["ts-node"],
+    deps = [
+        "//github-actions/commit-message-based-labels/lib",
+    ],
+)

github-actions/breaking-changes-label/lib/BUILD.bazel → github-actions/commit-message-based-labels/lib/BUILD.bazel

@@ -1,6 +1,6 @@
 load("//tools:defaults.bzl", "ts_library")
 
-package(default_visibility = ["//github-actions/breaking-changes-label:__subpackages__"])
+package(default_visibility = ["//github-actions/commit-message-based-labels:__subpackages__"])
 
 exports_files([
     "main.ts",

github-actions/commit-message-based-labels/lib/main.ts

@@ -0,0 +1,66 @@
+import * as core from '@actions/core';
+import {context} from '@actions/github';
+import {Octokit} from '@octokit/rest';
+import {parseCommitMessage} from '../../../ng-dev/commit-message/parse';
+import {breakingChangeLabel, deprecationLabel} from '../../../ng-dev/pr/config';
+import {ANGULAR_ROBOT, getAuthTokenFor} from '../../utils';
+
+/** List of supported label and commit message attribute combinations. */
+const supportedLabels = [
+  [breakingChangeLabel, 'breakingChanges'],
+  [deprecationLabel, 'deprecations'],
+] as const;
+
+async function run(): Promise<void> {
+  const token = await getAuthTokenFor(ANGULAR_ROBOT);
+  const client = new Octokit({auth: token});
+  const {number, owner, repo} = context.issue;
+  /** Labels currently applied to the PR. */
+  const labels = await (
+    await client.issues.listLabelsOnIssue({issue_number: number, owner, repo})
+  ).data;
+  /** Parsed commit message for every commit on the PR. */
+  const commits = await (
+    await client.paginate(client.pulls.listCommits, {owner, pull_number: number, repo})
+  ).map(({commit: {message}}) => parseCommitMessage(message));
+
+  console.log(`PR #${number}`);
+
+  // Add or Remove label as appropriate for each of the supported label and commit messaage
+  // combinations.
+  for (const [label, commitProperty] of supportedLabels) {
+    const hasCommit = commits.some((commit) => commit[commitProperty].length > 0);
+    const hasLabel = labels.some(({name}) => name === label);
+    console.log(`${commitProperty} | hasLabel: ${hasLabel} | hasCommit: ${hasCommit}`);
+
+    if (hasCommit && !hasLabel) {
+      await client.issues.addLabels({
+        repo,
+        owner,
+        issue_number: number,
+        labels: [label],
+      });
+      console.log(`Added ${label} label to PR #${number}`);
+    }
+    if (!hasCommit && hasLabel) {
+      await client.issues.removeLabel({
+        repo,
+        owner,
+        issue_number: number,
+        name: label,
+      });
+      console.log(`Removed ${label} label from PR #${number}`);
+    }
+  }
+}
+
+// Only run if the action is executed in a repository within the Angular org. This is in place
+// to prevent the action from actually running in a fork of a repository with this action set up.
+if (context.repo.owner === 'angular') {
+  run();
+} else {
+  core.warning(
+    'Automatic labeling was skipped as this action is only meant to run ' +
+      'in repos belonging to the Angular organization.',
+  );
+}

ng-dev/commit-message/BUILD.bazel

@@ -7,7 +7,7 @@ ts_library(
         exclude = ["**/*.spec.ts"],
     ),
     visibility = [
-        "//github-actions/breaking-changes-label:__subpackages__",
+        "//github-actions/commit-message-based-labels:__subpackages__",
         "//ng-dev:__subpackages__",
     ],
     deps = [

ng-dev/pr/config/BUILD.bazel

@@ -4,7 +4,7 @@ ts_library(
     name = "config",
     srcs = ["index.ts"],
     visibility = [
-        "//github-actions/breaking-changes-label/lib:__pkg__",
+        "//github-actions/commit-message-based-labels/lib:__pkg__",
         "//ng-dev:__subpackages__",
     ],
     deps = [

ng-dev/pr/config/index.ts

@@ -78,3 +78,6 @@ export function assertValidPullRequestConfig<T>(
 
 /** Label for pull requests containing a breaking change. */
 export const breakingChangeLabel = 'flag: breaking change';
+
+/** Label for pull requests containing a deprecation. */
+export const deprecationLabel = 'flag: deprecation';