Assigns labels based on branch names

README.md

@@ -9,7 +9,7 @@
   </a>
 </p>
 
-Automatically label new pull requests based on the paths of files being changed.
+Automatically label new pull requests based on the paths of files being changed or the branch name.
 
 ## Usage
 
@@ -26,13 +26,15 @@ For more control over matching, you can provide a match object instead of a simp
 ```yml
 - any: ['list', 'of', 'globs']
   all: ['list', 'of', 'globs']
+  branch: ['list', 'of, 'globs']
 ```
 
-One or both fields can be provided for fine-grained matching. Unlike the top-level list, the list of path globs provided to `any` and `all` must ALL match against a path for the label to be applied.
+One or all fields can be provided for fine-grained matching. Unlike the top-level list, the list of path globs provided to `any` and `all` must ALL match against a path for the label to be applied.
 
 The fields are defined as follows:
 * `any`: match ALL globs against ANY changed path
 * `all`: match ALL globs against ALL changed paths
+* `branch`: match ANY glob against the branch name
 
 A simple path glob is the equivalent to `any: ['glob']`. More specifically, the following two configurations are equivalent:
 ```yml
@@ -56,6 +58,10 @@ label1:
 
 # Add 'label2' to any file changes within 'example2' folder
 label2: example2/*
+
+# Add 'label3' to any PR where the branch name starts with 'example3'
+label3:
+- branch: 'example3/**'
 ```
 
 #### Common Examples
@@ -82,6 +88,10 @@ source:
 frontend:
 - any: ['src/**/*.js']
   all: ['!src/main.js']
+
+ # Add 'feature' label to any branch that starts with `feature` or has a `feature` section in the name
+ feature:
+ - branch: ['feature/**', '*/feaure/**']
 ```
 
 ### Create Workflow

__tests__/fixtures/branches.yml

@@ -0,0 +1,11 @@
+test-branch:
+  - branch: "test/**"
+
+feature-branch:
+  - branch: "*/feature/*"
+
+bug-branch:
+  - branch: "{bug,fix}/*"
+
+array-branch:
+  - branch: ["array/*"]

__tests__/main.test.ts

@@ -15,6 +15,7 @@ const paginateMock = jest.spyOn(gh, "paginate");
 const getPullMock = jest.spyOn(gh.rest.pulls, "get");
 
 const yamlFixtures = {
+  "branches.yml": fs.readFileSync("__tests__/fixtures/branches.yml"),
   "only_pdfs.yml": fs.readFileSync("__tests__/fixtures/only_pdfs.yml"),
 };
 
@@ -102,6 +103,64 @@ describe("run", () => {
     expect(addLabelsMock).toHaveBeenCalledTimes(0);
     expect(removeLabelMock).toHaveBeenCalledTimes(0);
   });
+
+  it("adds labels based on the branch names that match the glob pattern", async () => {
+    github.context.payload.pull_request!.head = { ref: "test/testing-time" };
+    usingLabelerConfigYaml("branches.yml");
+    await run();
+
+    expect(addLabelsMock).toHaveBeenCalledTimes(1);
+    expect(addLabelsMock).toHaveBeenCalledWith({
+      owner: "monalisa",
+      repo: "helloworld",
+      issue_number: 123,
+      labels: ["test-branch"],
+    });
+  });
+
+  it("adds multiple labels based on branch names that match different glob patterns", async () => {
+    github.context.payload.pull_request!.head = {
+      ref: "test/feature/123",
+    };
+    usingLabelerConfigYaml("branches.yml");
+    await run();
+
+    expect(addLabelsMock).toHaveBeenCalledTimes(1);
+    expect(addLabelsMock).toHaveBeenCalledWith({
+      owner: "monalisa",
+      repo: "helloworld",
+      issue_number: 123,
+      labels: ["test-branch", "feature-branch"],
+    });
+  });
+
+  it("it can support multiple branches by batching", async () => {
+    github.context.payload.pull_request!.head = { ref: "fix/123" };
+    usingLabelerConfigYaml("branches.yml");
+    await run();
+
+    expect(addLabelsMock).toHaveBeenCalledTimes(1);
+    expect(addLabelsMock).toHaveBeenCalledWith({
+      owner: "monalisa",
+      repo: "helloworld",
+      issue_number: 123,
+      labels: ["bug-branch"],
+    });
+  });
+
+  it("it can support multiple branches by providing an array", async () => {
+    github.context.payload.pull_request!.head = { ref: "array/123" };
+    usingLabelerConfigYaml("branches.yml");
+    await run();
+
+    expect(addLabelsMock).toHaveBeenCalledTimes(1);
+    expect(addLabelsMock).toHaveBeenCalledWith({
+      owner: "monalisa",
+      repo: "helloworld",
+      issue_number: 123,
+      labels: ["array-branch"],
+    });
+  });
 });
 
 function usingLabelerConfigYaml(fixtureName: keyof typeof yamlFixtures): void {

dist/index.js

@@ -96,6 +96,14 @@ function getPrNumber() {
     }
     return pullRequest.number;
 }
+function getBranchName() {
+    var _a;
+    const pullRequest = github.context.payload.pull_request;
+    if (!pullRequest) {
+        return undefined;
+    }
+    return (_a = pullRequest.head) === null || _a === void 0 ? void 0 : _a.ref;
+}
 function getChangedFiles(client, prNumber) {
     return __awaiter(this, void 0, void 0, function* () {
         const listFilesOptions = client.rest.pulls.listFiles.endpoint.merge({
@@ -207,6 +215,38 @@ function checkAll(changedFiles, globs) {
     core.debug(`  "all" patterns matched all files`);
     return true;
 }
+function matchBranchPattern(matcher, branchName) {
+    core.debug(`  - ${printPattern(matcher)}`);
+    if (matcher.match(branchName)) {
+        core.debug(`   "branch" pattern matched`);
+        return true;
+    }
+    core.debug(`   ${printPattern(matcher)} did not match`);
+    return false;
+}
+function checkBranch(glob) {
+    const branchName = getBranchName();
+    if (!branchName) {
+        core.debug(` no branch name`);
+        return false;
+    }
+    core.debug(` checking "branch" pattern against ${branchName}`);
+    if (Array.isArray(glob)) {
+        const matchers = glob.map((g) => new minimatch_1.Minimatch(g));
+        for (const matcher of matchers) {
+            if (matchBranchPattern(matcher, branchName)) {
+                core.debug(`  "branch" patterns matched against ${branchName}`);
+                return true;
+            }
+        }
+        core.debug(`  "branch" patterns did not match against ${branchName}`);
+        return false;
+    }
+    else {
+        const matcher = new minimatch_1.Minimatch(glob);
+        return matchBranchPattern(matcher, branchName);
+    }
+}
 function checkMatch(changedFiles, matchConfig) {
     if (matchConfig.all !== undefined) {
         if (!checkAll(changedFiles, matchConfig.all)) {
@@ -218,6 +258,11 @@ function checkMatch(changedFiles, matchConfig) {
             return false;
         }
     }
+    if (matchConfig.branch !== undefined) {
+        if (!checkBranch(matchConfig.branch)) {
+            return false;
+        }
+    }
     return true;
 }
 function addLabels(client, prNumber, labels) {

src/labeler.ts

@@ -6,6 +6,7 @@ import { Minimatch, IMinimatch } from "minimatch";
 interface MatchConfig {
   all?: string[];
   any?: string[];
+  branch?: string | string[];
 }
 
 type StringOrMatchConfig = string | MatchConfig;
@@ -71,6 +72,15 @@ function getPrNumber(): number | undefined {
   return pullRequest.number;
 }
 
+function getBranchName(): string | undefined {
+  const pullRequest = github.context.payload.pull_request;
+  if (!pullRequest) {
+    return undefined;
+  }
+
+  return pullRequest.head?.ref;
+}
+
 async function getChangedFiles(
   client: ClientType,
   prNumber: number
@@ -213,6 +223,42 @@ function checkAll(changedFiles: string[], globs: string[]): boolean {
   return true;
 }
 
+function matchBranchPattern(matcher: IMinimatch, branchName: string): boolean {
+  core.debug(`  - ${printPattern(matcher)}`);
+  if (matcher.match(branchName)) {
+    core.debug(`   "branch" pattern matched`);
+    return true;
+  }
+
+  core.debug(`   ${printPattern(matcher)} did not match`);
+  return false;
+}
+
+function checkBranch(glob: string | string[]): boolean {
+  const branchName = getBranchName();
+  if (!branchName) {
+    core.debug(` no branch name`);
+    return false;
+  }
+
+  core.debug(` checking "branch" pattern against ${branchName}`);
+  if (Array.isArray(glob)) {
+    const matchers = glob.map((g) => new Minimatch(g));
+    for (const matcher of matchers) {
+      if (matchBranchPattern(matcher, branchName)) {
+        core.debug(`  "branch" patterns matched against ${branchName}`);
+        return true;
+      }
+    }
+
+    core.debug(`  "branch" patterns did not match against ${branchName}`);
+    return false;
+  } else {
+    const matcher = new Minimatch(glob);
+    return matchBranchPattern(matcher, branchName);
+  }
+}
+
 function checkMatch(changedFiles: string[], matchConfig: MatchConfig): boolean {
   if (matchConfig.all !== undefined) {
     if (!checkAll(changedFiles, matchConfig.all)) {
@@ -226,6 +272,12 @@ function checkMatch(changedFiles: string[], matchConfig: MatchConfig): boolean {
     }
   }
 
+  if (matchConfig.branch !== undefined) {
+    if (!checkBranch(matchConfig.branch)) {
+      return false;
+    }
+  }
+
   return true;
 }