[Beta] Implement the new structure of the match object for the changed-files section (#680)

* Implement the new structure of the match object for changed files section

* Replace inner loops with the find method

.eslintignore

@@ -0,0 +1,7 @@
+# Ignore list
+/*
+
+# Do not ignore these folders:
+!__tests__/
+!__mocks__/
+!src/

.eslintrc.js

@@ -0,0 +1,50 @@
+// This is a reusable configuration file copied from https://github.com/actions/reusable-workflows/tree/main/reusable-configurations. Please don't make changes to this file as it's the subject of an automatic update.
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:eslint-plugin-jest/recommended',
+    'eslint-config-prettier'
+  ],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'eslint-plugin-jest'],
+  rules: {
+    '@typescript-eslint/no-require-imports': 'error',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/ban-ts-comment': [
+      'error',
+      {
+        'ts-ignore': 'allow-with-description'
+      }
+    ],
+    'no-console': 'error',
+    'yoda': 'error',
+    'prefer-const': [
+      'error',
+      {
+        destructuring: 'all'
+      }
+    ],
+    'no-control-regex': 'off',
+    'no-constant-condition': ['error', {checkLoops: false}]
+  },
+  overrides: [
+    {
+      files: ['**/*{test,spec}.ts'],
+      rules: {
+        '@typescript-eslint/no-unused-vars': 'off',
+        'jest/no-standalone-expect': 'off',
+        'jest/no-conditional-expect': 'off',
+        'no-console': 'off',
+
+      }
+    }
+  ],
+  env: {
+    node: true,
+    es6: true,
+    'jest/globals': true
+  }
+};

.gitattributes

@@ -1,4 +1,4 @@
-* text=auto
+* text=auto eol=lf
 .licenses/** -diff linguist-generated=true
 
 # don't diff machine generated files

.github/workflows/codeql-analysis.yml

@@ -2,9 +2,9 @@ name: CodeQL analysis
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
   schedule:
     - cron: '0 3 * * 0'
 

.github/workflows/update-config-files.yml

@@ -0,0 +1,11 @@
+name: Update configuration files
+
+on:
+  schedule:
+    - cron: '0 3 * * 0'
+  workflow_dispatch:
+
+jobs:
+  call-update-configuration-files:
+    name: Update configuration files
+    uses: actions/reusable-workflows/.github/workflows/update-config-files.yml@main

.licenses/npm/minimatch.dep.yml

@@ -1,6 +1,6 @@
 ---
 name: minimatch
-version: 5.1.2
+version: 7.4.3
 type: npm
 summary: a glob matcher in javascript
 homepage: 

.prettierignore

@@ -0,0 +1,8 @@
+# Ignore list
+/*
+
+# Do not ignore these folders:
+!__tests__/
+!__mocks__/
+!.github/
+!src/

.prettierrc.js

@@ -0,0 +1,11 @@
+// This is a reusable configuration file copied from https://github.com/actions/reusable-workflows/tree/main/reusable-configurations. Please don't make changes to this file as it's the subject of an automatic update.
+module.exports = {
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'none',
+  bracketSpacing: false,
+  arrowParens: 'avoid'
+};

.prettierrc.json

@@ -1,12 +0,0 @@
-{
-    "printWidth": 80,
-    "tabWidth": 2,
-    "useTabs": false,
-    "semi": true,
-    "singleQuote": true,
-    "trailingComma": "none",
-    "bracketSpacing": false,
-    "arrowParens": "avoid",
-    "parser": "typescript",
-    "endOfLine": "auto"
-  }

README.md

@@ -2,58 +2,83 @@
 
 [![Basic validation](https://github.com/actions/labeler/actions/workflows/basic-validation.yml/badge.svg?branch=main)](https://github.com/actions/labeler/actions/workflows/basic-validation.yml)
 
-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
 
 ### Create `.github/labeler.yml`
 
-Create a `.github/labeler.yml` file with a list of labels and [minimatch](https://github.com/isaacs/minimatch) globs to match to apply the label.
+Create a `.github/labeler.yml` file with a list of labels and config options to match and apply the label.
 
-The key is the name of the label in your repository that you want to add (eg: "merge conflict", "needs-updating") and the value is the path (glob) of the changed files (eg: `src/**/*`, `tests/*.spec.js`) or a match object.
+The key is the name of the label in your repository that you want to add (eg: "merge conflict", "needs-updating") and the value is a match object.
 
 #### Match Object
 
-For more control over matching, you can provide a match object instead of a simple path glob. The match object is defined as:
+The match object allows control over the matching options, you can specify the label to be applied based on the files that have changed or the name of either the base branch or the head branch. For the changed files options you provide a [path glob](https://github.com/isaacs/minimatch#minimatch), and for the branches you provide a regexp to match against the branch name.
 
+The base match object is defined as:
 ```yml
-- any: ['list', 'of', 'globs']
-  all: ['list', 'of', 'globs']
+- changed-files: ['list', 'of', 'globs']
+- base-branch: ['list', 'of', 'regexps']
+- head-branch: ['list', 'of', 'regexps']
 ```
 
-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.
+There are two top level keys of `any` and `all`, which both accept the same config options:
+```yml
+- any:
+  - changed-files: ['list', 'of', 'globs']
+  - base-branch: ['list', 'of', 'regexps']
+  - head-branch: ['list', 'of', 'regexps']
+- all:
+  - changed-files: ['list', 'of', 'globs']
+  - base-branch: ['list', 'of', 'regexps']
+  - head-branch: ['list', 'of', 'regexps']
+```
 
+One or all fields can be provided for fine-grained matching.
 The fields are defined as follows:
-* `any`: match ALL globs against ANY changed path
-* `all`: match ALL globs against ALL changed paths
+* `all`: all of the provided options must match in order for the label to be applied
+* `any`: if any of the provided options match then a label will be applied
+* `base-branch`: match regexps against the base branch name
+* `changed-files`: match glob patterns against the changed paths
+* `head-branch`: match regexps against the head branch name
 
-A simple path glob is the equivalent to `any: ['glob']`. More specifically, the following two configurations are equivalent:
+If a base option is provided without a top-level key then it will default to `any`. More specifically, the following two configurations are equivalent:
 ```yml
 label1:
-- example1/*
+- changed-files: example1/*
 ```
 and
 ```yml
 label1:
-- any: ['example1/*']
+- any:
+  - changed-files: ['example1/*']
 ```
 
-From a boolean logic perspective, top-level match objects are `OR`-ed together and individual match rules within an object are `AND`-ed. Combined with `!` negation, you can write complex matching rules.
+From a boolean logic perspective, top-level match objects, and options within `all`  are `AND`-ed together and individual match rules within the `any` object are `OR`-ed. If path globs are combined with `!` negation, you can write complex matching rules.
 
 #### Basic Examples
 
 ```yml
 # Add 'label1' to any changes within 'example' folder or any subfolders
 label1:
-- example/**/*
+- changed-files: example/**/*
 
 # Add 'label2' to any file changes within 'example2' folder
-label2: example2/*
+label2:
+- changed-files: example2/*
 
 # Add label3 to any change to .txt files within the entire repository. Quotation marks are required for the leading asterisk
 label3:
-- '**/*.txt'
+- changed-files: '**/*.txt'
 
+# Add 'label4' to any PR where the head branch name starts with 'example4'
+label4:
+- head-branch: '^example4'
+
+# Add 'label5' to any PR where the base branch name starts with 'example5'
+label5:
+- base-branch: '^example5'
 ```
 
 #### Common Examples
@@ -61,25 +86,37 @@ label3:
 ```yml
 # Add 'repo' label to any root file changes
 repo:
-- '*'
+- changed-files: '*'
 
 # Add '@domain/core' label to any change within the 'core' package
 '@domain/core':
-- package/core/*
-- package/core/**/*
+- changed-files:
+  - package/core/*
+  - package/core/**/*
 
 # Add 'test' label to any change to *.spec.js files within the source dir
 test:
-- src/**/*.spec.js
+- changed-files: src/**/*.spec.js
 
 # Add 'source' label to any change to src files within the source dir EXCEPT for the docs sub-folder
 source:
-- any: ['src/**/*', '!src/docs/*']
+- changed-files:
+  - any: ['src/**/*', '!src/docs/*']
 
 # Add 'frontend` label to any change to *.js files as long as the `main.js` hasn't changed
 frontend:
-- any: ['src/**/*.js']
-  all: ['!src/main.js']
+- any:
+  - changed-files: ['src/**/*.js']
+- all:
+  - changed-files: ['!src/main.js']
+
+ # Add 'feature' label to any PR where the head branch name starts with `feature` or has a `feature` section in the name
+feature:
+ - head-branch: ['^feature', 'feature']
+
+ # Add 'release' label to any PR that is opened against the `main` branch
+release:
+ - base-branch: 'main'
 ```
 
 ### Create Workflow
@@ -98,7 +135,7 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/labeler@v4
+    - uses: actions/labeler@v5
 ```
 
 #### Inputs

__mocks__/@actions/github.ts

@@ -1,7 +1,13 @@
 export const context = {
   payload: {
     pull_request: {
-      number: 123
+      number: 123,
+      head: {
+        ref: 'head-branch-name'
+      },
+      base: {
+        ref: 'base-branch-name'
+      }
     }
   },
   repo: {

__tests__/branch.test.ts

@@ -0,0 +1,210 @@
+import {
+  getBranchName,
+  checkAnyBranch,
+  checkAllBranch,
+  toBranchMatchConfig,
+  BranchMatchConfig
+} from '../src/branch';
+import * as github from '@actions/github';
+
+jest.mock('@actions/core');
+jest.mock('@actions/github');
+
+describe('getBranchName', () => {
+  describe('when the pull requests base branch is requested', () => {
+    it('returns the base branch name', () => {
+      const result = getBranchName('base');
+      expect(result).toEqual('base-branch-name');
+    });
+  });
+
+  describe('when the pull requests head branch is requested', () => {
+    it('returns the head branch name', () => {
+      const result = getBranchName('head');
+      expect(result).toEqual('head-branch-name');
+    });
+  });
+});
+
+describe('checkAllBranch', () => {
+  beforeEach(() => {
+    github.context.payload.pull_request!.head = {
+      ref: 'test/feature/123'
+    };
+    github.context.payload.pull_request!.base = {
+      ref: 'main'
+    };
+  });
+
+  describe('when a single pattern is provided', () => {
+    describe('and the pattern matches the head branch', () => {
+      it('returns true', () => {
+        const result = checkAllBranch(['^test'], 'head');
+        expect(result).toBe(true);
+      });
+    });
+
+    describe('and the pattern does not match the head branch', () => {
+      it('returns false', () => {
+        const result = checkAllBranch(['^feature/'], 'head');
+        expect(result).toBe(false);
+      });
+    });
+  });
+
+  describe('when multiple patterns are provided', () => {
+    describe('and not all patterns matched', () => {
+      it('returns false', () => {
+        const result = checkAllBranch(['^test/', '^feature/'], 'head');
+        expect(result).toBe(false);
+      });
+    });
+
+    describe('and all patterns match', () => {
+      it('returns true', () => {
+        const result = checkAllBranch(['^test/', '/feature/'], 'head');
+        expect(result).toBe(true);
+      });
+    });
+
+    describe('and no patterns match', () => {
+      it('returns false', () => {
+        const result = checkAllBranch(['^feature/', '/test$'], 'head');
+        expect(result).toBe(false);
+      });
+    });
+  });
+
+  describe('when the branch to check is specified as the base branch', () => {
+    describe('and the pattern matches the base branch', () => {
+      it('returns true', () => {
+        const result = checkAllBranch(['^main$'], 'base');
+        expect(result).toBe(true);
+      });
+    });
+  });
+});
+
+describe('checkAnyBranch', () => {
+  beforeEach(() => {
+    github.context.payload.pull_request!.head = {
+      ref: 'test/feature/123'
+    };
+    github.context.payload.pull_request!.base = {
+      ref: 'main'
+    };
+  });
+
+  describe('when a single pattern is provided', () => {
+    describe('and the pattern matches the head branch', () => {
+      it('returns true', () => {
+        const result = checkAnyBranch(['^test'], 'head');
+        expect(result).toBe(true);
+      });
+    });
+
+    describe('and the pattern does not match the head branch', () => {
+      it('returns false', () => {
+        const result = checkAnyBranch(['^feature/'], 'head');
+        expect(result).toBe(false);
+      });
+    });
+  });
+
+  describe('when multiple patterns are provided', () => {
+    describe('and at least one pattern matches', () => {
+      it('returns true', () => {
+        const result = checkAnyBranch(['^test/', '^feature/'], 'head');
+        expect(result).toBe(true);
+      });
+    });
+
+    describe('and all patterns match', () => {
+      it('returns true', () => {
+        const result = checkAnyBranch(['^test/', '/feature/'], 'head');
+        expect(result).toBe(true);
+      });
+    });
+
+    describe('and no patterns match', () => {
+      it('returns false', () => {
+        const result = checkAnyBranch(['^feature/', '/test$'], 'head');
+        expect(result).toBe(false);
+      });
+    });
+  });
+
+  describe('when the branch to check is specified as the base branch', () => {
+    describe('and the pattern matches the base branch', () => {
+      it('returns true', () => {
+        const result = checkAnyBranch(['^main$'], 'base');
+        expect(result).toBe(true);
+      });
+    });
+  });
+});
+
+describe('toBranchMatchConfig', () => {
+  describe('when there are no branch keys in the config', () => {
+    const config = {'changed-files': [{any: ['testing']}]};
+
+    it('returns an empty object', () => {
+      const result = toBranchMatchConfig(config);
+      expect(result).toEqual({});
+    });
+  });
+
+  describe('when the config contains a head-branch option', () => {
+    const config = {'head-branch': ['testing']};
+
+    it('sets headBranch in the matchConfig', () => {
+      const result = toBranchMatchConfig(config);
+      expect(result).toEqual<BranchMatchConfig>({
+        headBranch: ['testing']
+      });
+    });
+
+    describe('and the matching option is a string', () => {
+      const stringConfig = {'head-branch': 'testing'};
+
+      it('sets headBranch in the matchConfig', () => {
+        const result = toBranchMatchConfig(stringConfig);
+        expect(result).toEqual<BranchMatchConfig>({
+          headBranch: ['testing']
+        });
+      });
+    });
+  });
+
+  describe('when the config contains a base-branch option', () => {
+    const config = {'base-branch': ['testing']};
+    it('sets baseBranch in the matchConfig', () => {
+      const result = toBranchMatchConfig(config);
+      expect(result).toEqual<BranchMatchConfig>({
+        baseBranch: ['testing']
+      });
+    });
+
+    describe('and the matching option is a string', () => {
+      const stringConfig = {'base-branch': 'testing'};
+
+      it('sets baseBranch in the matchConfig', () => {
+        const result = toBranchMatchConfig(stringConfig);
+        expect(result).toEqual<BranchMatchConfig>({
+          baseBranch: ['testing']
+        });
+      });
+    });
+  });
+
+  describe('when the config contains both a base-branch and head-branch option', () => {
+    const config = {'base-branch': ['testing'], 'head-branch': ['testing']};
+    it('sets headBranch and baseBranch in the matchConfig', () => {
+      const result = toBranchMatchConfig(config);
+      expect(result).toEqual<BranchMatchConfig>({
+        baseBranch: ['testing'],
+        headBranch: ['testing']
+      });
+    });
+  });
+});

__tests__/changedFiles.test.ts

@@ -0,0 +1,220 @@
+import {
+  ChangedFilesMatchConfig,
+  checkAllChangedFiles,
+  checkAnyChangedFiles,
+  toChangedFilesMatchConfig,
+  checkIfAnyGlobMatchesAnyFile,
+  checkIfAllGlobsMatchAnyFile,
+  checkIfAnyGlobMatchesAllFiles,
+  checkIfAllGlobsMatchAllFiles
+} from '../src/changedFiles';
+
+jest.mock('@actions/core');
+jest.mock('@actions/github');
+
+describe('checkAllChangedFiles', () => {
+  const changedFiles = ['foo.txt', 'bar.txt'];
+
+  describe('when all given glob pattern configs matched', () => {
+    const globPatternsConfigs = [
+      {AnyGlobToAnyFile: ['foo.txt']},
+      {AnyGlobToAllFiles: ['*.txt']},
+      {AllGlobsToAllFiles: ['**']}
+    ];
+
+    it('returns true', () => {
+      const result = checkAllChangedFiles(changedFiles, globPatternsConfigs);
+      expect(result).toBe(true);
+    });
+  });
+
+  describe(`when some given glob pattern config did not match`, () => {
+    const globPatternsConfigs = [
+      {AnyGlobToAnyFile: ['*.md']},
+      {AnyGlobToAllFiles: ['*.txt']},
+      {AllGlobsToAllFiles: ['**']}
+    ];
+
+    it('returns false', () => {
+      const result = checkAllChangedFiles(changedFiles, globPatternsConfigs);
+      expect(result).toBe(false);
+    });
+  });
+});
+
+describe('checkAnyChangedFiles', () => {
+  const changedFiles = ['foo.txt', 'bar.txt'];
+
+  describe('when any given glob pattern config matched', () => {
+    const globPatternsConfigs = [
+      {AnyGlobToAnyFile: ['*.md']},
+      {AnyGlobToAllFiles: ['*.txt']}
+    ];
+
+    it('returns true', () => {
+      const result = checkAnyChangedFiles(changedFiles, globPatternsConfigs);
+      expect(result).toBe(true);
+    });
+  });
+
+  describe('when none of the given glob pattern configs matched', () => {
+    const globPatternsConfigs = [
+      {AnyGlobToAnyFile: ['*.md']},
+      {AnyGlobToAllFiles: ['!*.txt']}
+    ];
+
+    it('returns false', () => {
+      const result = checkAnyChangedFiles(changedFiles, globPatternsConfigs);
+      expect(result).toBe(false);
+    });
+  });
+});
+
+describe('toChangedFilesMatchConfig', () => {
+  describe(`when there is no 'changed-files' key in the config`, () => {
+    const config = {'head-branch': 'test'};
+
+    it('returns an empty object', () => {
+      const result = toChangedFilesMatchConfig(config);
+      expect(result).toEqual<ChangedFilesMatchConfig>({});
+    });
+  });
+
+  describe(`when there is a 'changed-files' key in the config`, () => {
+    describe('but the glob pattern config key is not provided', () => {
+      const config = {'changed-files': ['bar']};
+
+      it('throws the error', () => {
+        expect(() => {
+          toChangedFilesMatchConfig(config);
+        }).toThrow(
+          `The "changed-files" section must have a valid config structure. Please read the action documentation for more information`
+        );
+      });
+    });
+
+    describe('but the glob pattern config key is not valid', () => {
+      const config = {'changed-files': [{NotValidConfigKey: ['bar']}]};
+
+      it('throws the error', () => {
+        expect(() => {
+          toChangedFilesMatchConfig(config);
+        }).toThrow(
+          `Unknown config options were under "changed-files": NotValidConfigKey`
+        );
+      });
+    });
+
+    describe('and the glob pattern config key is provided', () => {
+      describe('and the value is an array of strings', () => {
+        const config = {'changed-files': [{AnyGlobToAnyFile: ['testing']}]};
+
+        it('sets the value in the config object', () => {
+          const result = toChangedFilesMatchConfig(config);
+          expect(result).toEqual<ChangedFilesMatchConfig>({
+            changedFiles: [{AnyGlobToAnyFile: ['testing']}]
+          });
+        });
+      });
+
+      describe('and the value is a string', () => {
+        const config = {'changed-files': [{AnyGlobToAnyFile: 'testing'}]};
+
+        it(`sets the string as an array in the config object`, () => {
+          const result = toChangedFilesMatchConfig(config);
+          expect(result).toEqual<ChangedFilesMatchConfig>({
+            changedFiles: [{AnyGlobToAnyFile: ['testing']}]
+          });
+        });
+      });
+    });
+  });
+});
+
+describe('checkIfAnyGlobMatchesAnyFile', () => {
+  const changedFiles = ['foo.txt', 'bar.txt'];
+
+  describe('when any given glob pattern matched any file', () => {
+    const globPatterns = ['*.md', 'foo.txt'];
+
+    it('returns true', () => {
+      const result = checkIfAnyGlobMatchesAnyFile(changedFiles, globPatterns);
+      expect(result).toBe(true);
+    });
+  });
+
+  describe('when none of the given glob pattern matched any file', () => {
+    const globPatterns = ['*.md', '!*.txt'];
+
+    it('returns false', () => {
+      const result = checkIfAnyGlobMatchesAnyFile(changedFiles, globPatterns);
+      expect(result).toBe(false);
+    });
+  });
+});
+
+describe('checkIfAllGlobsMatchAnyFile', () => {
+  const changedFiles = ['foo.txt', 'bar.txt'];
+
+  describe('when all given glob patterns matched any file', () => {
+    const globPatterns = ['**/bar.txt', 'bar.txt'];
+
+    it('returns true', () => {
+      const result = checkIfAllGlobsMatchAnyFile(changedFiles, globPatterns);
+      expect(result).toBe(true);
+    });
+  });
+
+  describe('when some of the given glob patterns did not match any file', () => {
+    const globPatterns = ['*.txt', '*.md'];
+
+    it('returns false', () => {
+      const result = checkIfAllGlobsMatchAnyFile(changedFiles, globPatterns);
+      expect(result).toBe(false);
+    });
+  });
+});
+
+describe('checkIfAnyGlobMatchesAllFiles', () => {
+  const changedFiles = ['foo.txt', 'bar.txt'];
+
+  describe('when any given glob pattern matched all files', () => {
+    const globPatterns = ['*.md', '*.txt'];
+
+    it('returns true', () => {
+      const result = checkIfAnyGlobMatchesAllFiles(changedFiles, globPatterns);
+      expect(result).toBe(true);
+    });
+  });
+
+  describe('when none of the given glob patterns matched all files', () => {
+    const globPatterns = ['*.md', 'bar.txt', 'foo.txt'];
+
+    it('returns false', () => {
+      const result = checkIfAnyGlobMatchesAllFiles(changedFiles, globPatterns);
+      expect(result).toBe(false);
+    });
+  });
+});
+
+describe('checkIfAllGlobsMatchAllFiles', () => {
+  const changedFiles = ['foo.txt', 'bar.txt'];
+
+  describe('when all given glob patterns matched all files', () => {
+    const globPatterns = ['*.txt', '**'];
+
+    it('returns true', () => {
+      const result = checkIfAllGlobsMatchAllFiles(changedFiles, globPatterns);
+      expect(result).toBe(true);
+    });
+  });
+
+  describe('when some of the given glob patterns did not match all files', () => {
+    const globPatterns = ['**', 'foo.txt'];
+
+    it('returns false', () => {
+      const result = checkIfAllGlobsMatchAllFiles(changedFiles, globPatterns);
+      expect(result).toBe(false);
+    });
+  });
+});

__tests__/fixtures/all_options.yml

@@ -0,0 +1,17 @@
+label1:
+  - any:
+      - changed-files:
+          - AnyGlobToAnyFile: ['glob']
+      - head-branch: ['regexp']
+      - base-branch: ['regexp']
+  - all:
+      - changed-files:
+          - AllGlobsToAllFiles: ['glob']
+      - head-branch: ['regexp']
+      - base-branch: ['regexp']
+
+label2:
+  - changed-files:
+      - AnyGlobToAnyFile: ['glob']
+  - head-branch: ['regexp']
+  - base-branch: ['regexp']

__tests__/fixtures/any_and_all.yml

@@ -0,0 +1,8 @@
+tests:
+  - any:
+      - head-branch: ['^tests/', '^test/']
+      - changed-files:
+          - AnyGlobToAnyFile: ['tests/**/*']
+  - all:
+      - changed-files:
+          - AllGlobsToAllFiles: ['!tests/requirements.txt']

__tests__/fixtures/branches.yml

@@ -0,0 +1,11 @@
+test-branch:
+  - head-branch: '^test/'
+
+feature-branch:
+  - head-branch: '/feature/'
+
+bug-branch:
+  - head-branch: '^bug/|fix/'
+
+array-branch:
+  - head-branch: ['^array/']

__tests__/fixtures/not_supported.yml

@@ -0,0 +1,3 @@
+label:
+  - all:
+      - unknown: 'this-is-not-supported'

__tests__/fixtures/only_pdfs.yml

@@ -1,2 +1,3 @@
 touched-a-pdf-file:
-  - any: ['*.pdf']
+  - changed-files:
+      - AnyGlobToAnyFile: ['*.pdf']

__tests__/labeler.test.ts

@@ -1,6 +1,13 @@
-import {checkGlobs} from '../src/labeler';
-
+import {
+  checkMatchConfigs,
+  MatchConfig,
+  toMatchConfig,
+  getLabelConfigMapFromObject,
+  BaseMatchConfig
+} from '../src/labeler';
+import * as yaml from 'js-yaml';
 import * as core from '@actions/core';
+import * as fs from 'fs';
 
 jest.mock('@actions/core');
 
@@ -10,20 +17,131 @@ beforeAll(() => {
   });
 });
 
-const matchConfig = [{any: ['*.txt']}];
+const loadYaml = (filepath: string) => {
+  const loadedFile = fs.readFileSync(filepath);
+  const content = Buffer.from(loadedFile).toString();
+  return yaml.load(content);
+};
+
+describe('getLabelConfigMapFromObject', () => {
+  const yamlObject = loadYaml('__tests__/fixtures/all_options.yml');
+  const expected = new Map<string, MatchConfig[]>();
+  expected.set('label1', [
+    {
+      any: [
+        {changedFiles: [{AnyGlobToAnyFile: ['glob']}]},
+        {baseBranch: undefined, headBranch: ['regexp']},
+        {baseBranch: ['regexp'], headBranch: undefined}
+      ]
+    },
+    {
+      all: [
+        {changedFiles: [{AllGlobsToAllFiles: ['glob']}]},
+        {baseBranch: undefined, headBranch: ['regexp']},
+        {baseBranch: ['regexp'], headBranch: undefined}
+      ]
+    }
+  ]);
+  expected.set('label2', [
+    {
+      any: [
+        {changedFiles: [{AnyGlobToAnyFile: ['glob']}]},
+        {baseBranch: undefined, headBranch: ['regexp']},
+        {baseBranch: ['regexp'], headBranch: undefined}
+      ]
+    }
+  ]);
+
+  it('returns a MatchConfig', () => {
+    const result = getLabelConfigMapFromObject(yamlObject);
+    expect(result).toEqual(expected);
+  });
+});
+
+describe('toMatchConfig', () => {
+  describe('when all expected config options are present', () => {
+    const config = {
+      'changed-files': [{AnyGlobToAnyFile: ['testing-files']}],
+      'head-branch': ['testing-head'],
+      'base-branch': ['testing-base']
+    };
+    const expected: BaseMatchConfig = {
+      changedFiles: [{AnyGlobToAnyFile: ['testing-files']}],
+      headBranch: ['testing-head'],
+      baseBranch: ['testing-base']
+    };
+
+    it('returns a MatchConfig object with all options', () => {
+      const result = toMatchConfig(config);
+      expect(result).toEqual(expected);
+    });
+
+    describe('and there are also unexpected options present', () => {
+      config['test-test'] = 'testing';
+
+      it('does not include the unexpected items in the returned MatchConfig object', () => {
+        const result = toMatchConfig(config);
+        expect(result).toEqual(expected);
+      });
+    });
+  });
+});
+
+describe('checkMatchConfigs', () => {
+  describe('when a single match config is provided', () => {
+    const matchConfig: MatchConfig[] = [
+      {any: [{changedFiles: [{AnyGlobToAnyFile: ['*.txt']}]}]}
+    ];
 
-describe('checkGlobs', () => {
     it('returns true when our pattern does match changed files', () => {
       const changedFiles = ['foo.txt', 'bar.txt'];
-    const result = checkGlobs(changedFiles, matchConfig);
+      const result = checkMatchConfigs(changedFiles, matchConfig);
 
       expect(result).toBeTruthy();
     });
 
     it('returns false when our pattern does not match changed files', () => {
       const changedFiles = ['foo.docx'];
-    const result = checkGlobs(changedFiles, matchConfig);
+      const result = checkMatchConfigs(changedFiles, matchConfig);
 
       expect(result).toBeFalsy();
     });
+
+    it('returns true when either the branch or changed files patter matches', () => {
+      const matchConfig: MatchConfig[] = [
+        {
+          any: [
+            {changedFiles: [{AnyGlobToAnyFile: ['*.txt']}]},
+            {headBranch: ['some-branch']}
+          ]
+        }
+      ];
+      const changedFiles = ['foo.txt', 'bar.txt'];
+
+      const result = checkMatchConfigs(changedFiles, matchConfig);
+      expect(result).toBe(true);
+    });
+  });
+
+  describe('when multiple MatchConfigs are supplied', () => {
+    const matchConfig: MatchConfig[] = [
+      {any: [{changedFiles: [{AnyGlobToAnyFile: ['*.txt']}]}]},
+      {any: [{headBranch: ['some-branch']}]}
+    ];
+    const changedFiles = ['foo.txt', 'bar.md'];
+
+    it('returns false when only one config matches', () => {
+      const result = checkMatchConfigs(changedFiles, matchConfig);
+      expect(result).toBe(false);
+    });
+
+    it('returns true when only both config matches', () => {
+      const matchConfig: MatchConfig[] = [
+        {any: [{changedFiles: [{AnyGlobToAnyFile: ['*.txt']}]}]},
+        {any: [{headBranch: ['head-branch']}]}
+      ];
+      const result = checkMatchConfigs(changedFiles, matchConfig);
+      expect(result).toBe(true);
+    });
+  });
 });

__tests__/main.test.ts

@@ -15,7 +15,10 @@ const paginateMock = jest.spyOn(gh, 'paginate');
 const getPullMock = jest.spyOn(gh.rest.pulls, 'get');
 
 const yamlFixtures = {
-  'only_pdfs.yml': fs.readFileSync('__tests__/fixtures/only_pdfs.yml')
+  'branches.yml': fs.readFileSync('__tests__/fixtures/branches.yml'),
+  'only_pdfs.yml': fs.readFileSync('__tests__/fixtures/only_pdfs.yml'),
+  'not_supported.yml': fs.readFileSync('__tests__/fixtures/not_supported.yml'),
+  'any_and_all.yml': fs.readFileSync('__tests__/fixtures/any_and_all.yml')
 };
 
 afterAll(() => jest.restoreAllMocks());
@@ -47,16 +50,29 @@ describe('run', () => {
     expect(addLabelsMock).toHaveBeenCalledTimes(0);
   });
 
+  it('does not add a label when the match config options are not supported', async () => {
+    usingLabelerConfigYaml('not_supported.yml');
+    await run();
+
+    expect(addLabelsMock).toHaveBeenCalledTimes(0);
+    expect(removeLabelMock).toHaveBeenCalledTimes(0);
+  });
+
   it('(with sync-labels: true) it deletes preexisting PR labels that no longer match the glob pattern', async () => {
-    let mockInput = {
+    const mockInput = {
       'repo-token': 'foo',
       'configuration-path': 'bar',
-      'sync-labels': true
+      'sync-labels': 'true'
     };
 
     jest
       .spyOn(core, 'getInput')
       .mockImplementation((name: string, ...opts) => mockInput[name]);
+    jest
+      .spyOn(core, 'getBooleanInput')
+      .mockImplementation(
+        (name: string, ...opts) => mockInput[name] === 'true'
+      );
 
     usingLabelerConfigYaml('only_pdfs.yml');
     mockGitHubResponseChangedFiles('foo.txt');
@@ -79,15 +95,20 @@ describe('run', () => {
   });
 
   it('(with sync-labels: false) it issues no delete calls even when there are preexisting PR labels that no longer match the glob pattern', async () => {
-    let mockInput = {
+    const mockInput = {
       'repo-token': 'foo',
       'configuration-path': 'bar',
-      'sync-labels': false
+      'sync-labels': 'false'
     };
 
     jest
       .spyOn(core, 'getInput')
       .mockImplementation((name: string, ...opts) => mockInput[name]);
+    jest
+      .spyOn(core, 'getBooleanInput')
+      .mockImplementation(
+        (name: string, ...opts) => mockInput[name] === 'true'
+      );
 
     usingLabelerConfigYaml('only_pdfs.yml');
     mockGitHubResponseChangedFiles('foo.txt');
@@ -102,6 +123,87 @@ describe('run', () => {
     expect(addLabelsMock).toHaveBeenCalledTimes(0);
     expect(removeLabelMock).toHaveBeenCalledTimes(0);
   });
+
+  it('adds labels based on the branch names that match the regexp 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 regexp 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('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('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']
+    });
+  });
+
+  it('adds a label when matching any and all patterns are provided', async () => {
+    usingLabelerConfigYaml('any_and_all.yml');
+    mockGitHubResponseChangedFiles('tests/test.ts');
+    await run();
+
+    expect(addLabelsMock).toHaveBeenCalledTimes(1);
+    expect(addLabelsMock).toHaveBeenCalledWith({
+      owner: 'monalisa',
+      repo: 'helloworld',
+      issue_number: 123,
+      labels: ['tests']
+    });
+  });
+
+  it('does not add a label when not all any and all patterns are matched', async () => {
+    usingLabelerConfigYaml('any_and_all.yml');
+    mockGitHubResponseChangedFiles('tests/requirements.txt');
+    await run();
+
+    expect(addLabelsMock).toHaveBeenCalledTimes(0);
+    expect(removeLabelMock).toHaveBeenCalledTimes(0);
+  });
 });
 
 function usingLabelerConfigYaml(fixtureName: keyof typeof yamlFixtures): void {

package.json

@@ -5,9 +5,10 @@
   "main": "lib/main.js",
   "scripts": {
     "build": "tsc && ncc build lib/main.js",
-    "format": "prettier --write **/*.ts",
-    "format-check": "prettier --check **/*.ts",
-    "lint": "echo \"Fake command that does nothing. It is used in reusable workflows\"",
+    "format": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --write \"**/*.{ts,yml,yaml}\"",
+    "format-check": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --check \"**/*.{ts,yml,yaml}\"",
+    "lint": "eslint --config ./.eslintrc.js \"**/*.ts\"",
+    "lint:fix": "eslint --config ./.eslintrc.js \"**/*.ts\" --fix",
     "test": "jest"
   },
   "repository": {
@@ -26,16 +27,21 @@
     "@actions/core": "^1.10.0",
     "@actions/github": "^5.1.1",
     "js-yaml": "^4.1.0",
-    "minimatch": "^5.1.2"
+    "minimatch": "^7.4.3"
   },
   "devDependencies": {
     "@types/jest": "^27.4.1",
-    "@types/node": "^16.11.7",
-    "@types/minimatch": "^5.1.2",
     "@types/js-yaml": "^4.0.5",
+    "@types/minimatch": "^5.1.2",
+    "@types/node": "^16.11.7",
+    "@typescript-eslint/eslint-plugin": "^5.59.7",
+    "@typescript-eslint/parser": "^5.59.7",
     "@vercel/ncc": "^0.36.1",
+    "eslint": "^8.41.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-jest": "^27.2.1",
     "jest": "^27.5.1",
-    "prettier": "^2.8.4",
+    "prettier": "^2.8.8",
     "ts-jest": "^27.1.3",
     "typescript": "^4.9.5"
   }

src/branch.ts

@@ -0,0 +1,98 @@
+import * as core from '@actions/core';
+import * as github from '@actions/github';
+
+export interface BranchMatchConfig {
+  headBranch?: string[];
+  baseBranch?: string[];
+}
+
+type BranchBase = 'base' | 'head';
+
+export function toBranchMatchConfig(config: any): BranchMatchConfig {
+  if (!config['head-branch'] && !config['base-branch']) {
+    return {};
+  }
+
+  const branchConfig = {
+    headBranch: config['head-branch'],
+    baseBranch: config['base-branch']
+  };
+
+  for (const branchName in branchConfig) {
+    if (typeof branchConfig[branchName] === 'string') {
+      branchConfig[branchName] = [branchConfig[branchName]];
+    }
+  }
+
+  return branchConfig;
+}
+
+export function getBranchName(branchBase: BranchBase): string | undefined {
+  const pullRequest = github.context.payload.pull_request;
+  if (!pullRequest) {
+    return undefined;
+  }
+
+  if (branchBase === 'base') {
+    return pullRequest.base?.ref;
+  } else {
+    return pullRequest.head?.ref;
+  }
+}
+
+export function checkAnyBranch(
+  regexps: string[],
+  branchBase: BranchBase
+): boolean {
+  const branchName = getBranchName(branchBase);
+  if (!branchName) {
+    core.debug(`   no branch name`);
+    return false;
+  }
+
+  core.debug(`   checking "branch" pattern against ${branchName}`);
+  const matchers = regexps.map(regexp => new RegExp(regexp));
+  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;
+}
+
+export function checkAllBranch(
+  regexps: string[],
+  branchBase: BranchBase
+): boolean {
+  const branchName = getBranchName(branchBase);
+  if (!branchName) {
+    core.debug(`   cannot fetch branch name from the pull request`);
+    return false;
+  }
+
+  core.debug(`   checking "branch" pattern against ${branchName}`);
+  const matchers = regexps.map(regexp => new RegExp(regexp));
+  for (const matcher of matchers) {
+    if (!matchBranchPattern(matcher, branchName)) {
+      core.debug(`   "branch" patterns did not match against ${branchName}`);
+      return false;
+    }
+  }
+
+  core.debug(`   "branch" patterns matched against ${branchName}`);
+  return true;
+}
+
+function matchBranchPattern(matcher: RegExp, branchName: string): boolean {
+  core.debug(`    - ${matcher}`);
+  if (matcher.test(branchName)) {
+    core.debug(`    "branch" pattern matched`);
+    return true;
+  }
+
+  core.debug(`    ${matcher} did not match`);
+  return false;
+}

src/changedFiles.ts

@@ -0,0 +1,353 @@
+import * as core from '@actions/core';
+import * as github from '@actions/github';
+import {Minimatch} from 'minimatch';
+
+export interface ChangedFilesMatchConfig {
+  changedFiles?: ChangedFilesGlobPatternsConfig[];
+}
+
+interface ChangedFilesGlobPatternsConfig {
+  AnyGlobToAnyFile?: string[];
+  AnyGlobToAllFiles?: string[];
+  AllGlobsToAnyFile?: string[];
+  AllGlobsToAllFiles?: string[];
+}
+
+type ClientType = ReturnType<typeof github.getOctokit>;
+
+const ALLOWED_FILES_CONFIG_KEYS = [
+  'AnyGlobToAnyFile',
+  'AnyGlobToAllFiles',
+  'AllGlobsToAnyFile',
+  'AllGlobsToAllFiles'
+];
+
+export async function getChangedFiles(
+  client: ClientType,
+  prNumber: number
+): Promise<string[]> {
+  const listFilesOptions = client.rest.pulls.listFiles.endpoint.merge({
+    owner: github.context.repo.owner,
+    repo: github.context.repo.repo,
+    pull_number: prNumber
+  });
+
+  const listFilesResponse = await client.paginate(listFilesOptions);
+  const changedFiles = listFilesResponse.map((f: any) => f.filename);
+
+  core.debug('found changed files:');
+  for (const file of changedFiles) {
+    core.debug('  ' + file);
+  }
+
+  return changedFiles;
+}
+
+export function toChangedFilesMatchConfig(
+  config: any
+): ChangedFilesMatchConfig {
+  if (!config['changed-files'] || !config['changed-files'].length) {
+    return {};
+  }
+  const changedFilesConfigs = Array.isArray(config['changed-files'])
+    ? config['changed-files']
+    : [config['changed-files']];
+
+  const validChangedFilesConfigs: ChangedFilesGlobPatternsConfig[] = [];
+
+  changedFilesConfigs.forEach(changedFilesConfig => {
+    if (!isObject(changedFilesConfig)) {
+      throw new Error(
+        `The "changed-files" section must have a valid config structure. Please read the action documentation for more information`
+      );
+    }
+
+    const changedFilesConfigKeys = Object.keys(changedFilesConfig);
+    const invalidKeys = changedFilesConfigKeys.filter(
+      key => !ALLOWED_FILES_CONFIG_KEYS.includes(key)
+    );
+
+    if (invalidKeys.length) {
+      throw new Error(
+        `Unknown config options were under "changed-files": ${invalidKeys.join(
+          ', '
+        )}`
+      );
+    }
+
+    changedFilesConfigKeys.forEach(key => {
+      validChangedFilesConfigs.push({
+        [key]: Array.isArray(changedFilesConfig[key])
+          ? changedFilesConfig[key]
+          : [changedFilesConfig[key]]
+      });
+    });
+  });
+
+  return {
+    changedFiles: validChangedFilesConfigs
+  };
+}
+
+function isObject(obj: unknown): obj is object {
+  return obj !== null && typeof obj === 'object' && !Array.isArray(obj);
+}
+
+function printPattern(matcher: Minimatch): string {
+  return (matcher.negate ? '!' : '') + matcher.pattern;
+}
+
+export function checkAnyChangedFiles(
+  changedFiles: string[],
+  globPatternsConfigs: ChangedFilesGlobPatternsConfig[]
+): boolean {
+  core.debug(`   checking "changed-files" patterns`);
+
+  for (const globPatternsConfig of globPatternsConfigs) {
+    if (globPatternsConfig.AnyGlobToAnyFile) {
+      if (
+        checkIfAnyGlobMatchesAnyFile(
+          changedFiles,
+          globPatternsConfig.AnyGlobToAnyFile
+        )
+      ) {
+        core.debug(`   "changed-files" matched`);
+        return true;
+      }
+    }
+
+    if (globPatternsConfig.AnyGlobToAllFiles) {
+      if (
+        checkIfAnyGlobMatchesAllFiles(
+          changedFiles,
+          globPatternsConfig.AnyGlobToAllFiles
+        )
+      ) {
+        core.debug(`   "changed-files" matched`);
+        return true;
+      }
+    }
+
+    if (globPatternsConfig.AllGlobsToAnyFile) {
+      if (
+        checkIfAllGlobsMatchAnyFile(
+          changedFiles,
+          globPatternsConfig.AllGlobsToAnyFile
+        )
+      ) {
+        core.debug(`   "changed-files" matched`);
+        return true;
+      }
+    }
+
+    if (globPatternsConfig.AllGlobsToAllFiles) {
+      if (
+        checkIfAllGlobsMatchAllFiles(
+          changedFiles,
+          globPatternsConfig.AllGlobsToAllFiles
+        )
+      ) {
+        core.debug(`   "changed-files" matched`);
+        return true;
+      }
+    }
+  }
+
+  core.debug(`   "changed-files" did not match`);
+  return false;
+}
+
+export function checkAllChangedFiles(
+  changedFiles: string[],
+  globPatternsConfigs: ChangedFilesGlobPatternsConfig[]
+): boolean {
+  core.debug(`   checking "changed-files" patterns`);
+
+  for (const globPatternsConfig of globPatternsConfigs) {
+    if (globPatternsConfig.AnyGlobToAnyFile) {
+      if (
+        !checkIfAnyGlobMatchesAnyFile(
+          changedFiles,
+          globPatternsConfig.AnyGlobToAnyFile
+        )
+      ) {
+        core.debug(`   "changed-files" did not match`);
+        return false;
+      }
+    }
+
+    if (globPatternsConfig.AnyGlobToAllFiles) {
+      if (
+        !checkIfAnyGlobMatchesAllFiles(
+          changedFiles,
+          globPatternsConfig.AnyGlobToAllFiles
+        )
+      ) {
+        core.debug(`   "changed-files" did not match`);
+        return false;
+      }
+    }
+
+    if (globPatternsConfig.AllGlobsToAnyFile) {
+      if (
+        !checkIfAllGlobsMatchAnyFile(
+          changedFiles,
+          globPatternsConfig.AllGlobsToAnyFile
+        )
+      ) {
+        core.debug(`   "changed-files" did not match`);
+        return false;
+      }
+    }
+
+    if (globPatternsConfig.AllGlobsToAllFiles) {
+      if (
+        !checkIfAllGlobsMatchAllFiles(
+          changedFiles,
+          globPatternsConfig.AllGlobsToAllFiles
+        )
+      ) {
+        core.debug(`   "changed-files" did not match`);
+        return false;
+      }
+    }
+  }
+
+  core.debug(`   "changed-files" patterns matched`);
+  return true;
+}
+
+export function checkIfAnyGlobMatchesAnyFile(
+  changedFiles: string[],
+  globs: string[]
+): boolean {
+  core.debug(`    checking "AnyGlobToAnyFile" config patterns`);
+  const matchers = globs.map(g => new Minimatch(g));
+
+  for (const matcher of matchers) {
+    const matchedFile = changedFiles.find(changedFile => {
+      core.debug(
+        `     checking "${printPattern(
+          matcher
+        )}" pattern against ${changedFile}`
+      );
+
+      return matcher.match(changedFile);
+    });
+
+    if (matchedFile) {
+      core.debug(
+        `     "${printPattern(matcher)}" pattern matched ${matchedFile}`
+      );
+      return true;
+    }
+  }
+
+  core.debug(`    none of the patterns matched any of the files`);
+  return false;
+}
+
+export function checkIfAllGlobsMatchAnyFile(
+  changedFiles: string[],
+  globs: string[]
+): boolean {
+  core.debug(`    checking "AllGlobsToAnyFile" config patterns`);
+  const matchers = globs.map(g => new Minimatch(g));
+
+  for (const changedFile of changedFiles) {
+    const mismatchedGlob = matchers.find(matcher => {
+      core.debug(
+        `     checking "${printPattern(
+          matcher
+        )}" pattern against ${changedFile}`
+      );
+
+      return !matcher.match(changedFile);
+    });
+
+    if (mismatchedGlob) {
+      core.debug(
+        `     "${printPattern(
+          mismatchedGlob
+        )}" pattern did not match ${changedFile}`
+      );
+
+      continue;
+    }
+
+    core.debug(`    all patterns matched ${changedFile}`);
+    return true;
+  }
+
+  core.debug(`    none of the files matched all patterns`);
+  return false;
+}
+
+export function checkIfAnyGlobMatchesAllFiles(
+  changedFiles: string[],
+  globs: string[]
+): boolean {
+  core.debug(`    checking "AnyGlobToAllFiles" config patterns`);
+  const matchers = globs.map(g => new Minimatch(g));
+
+  for (const matcher of matchers) {
+    const mismatchedFile = changedFiles.find(changedFile => {
+      core.debug(
+        `     checking "${printPattern(
+          matcher
+        )}" pattern against ${changedFile}`
+      );
+
+      return !matcher.match(changedFile);
+    });
+
+    if (mismatchedFile) {
+      core.debug(
+        `     "${printPattern(
+          matcher
+        )}" pattern did not match ${mismatchedFile}`
+      );
+
+      continue;
+    }
+
+    core.debug(`    "${printPattern(matcher)}" pattern matched all files`);
+    return true;
+  }
+
+  core.debug(`    none of the patterns matched all files`);
+  return false;
+}
+
+export function checkIfAllGlobsMatchAllFiles(
+  changedFiles: string[],
+  globs: string[]
+): boolean {
+  core.debug(`    checking "AllGlobsToAllFiles" config patterns`);
+  const matchers = globs.map(g => new Minimatch(g));
+
+  for (const changedFile of changedFiles) {
+    const mismatchedGlob = matchers.find(matcher => {
+      core.debug(
+        `     checking "${printPattern(
+          matcher
+        )}" pattern against ${changedFile}`
+      );
+
+      return !matcher.match(changedFile);
+    });
+
+    if (mismatchedGlob) {
+      core.debug(
+        `     "${printPattern(
+          mismatchedGlob
+        )}" pattern did not match ${changedFile}`
+      );
+
+      return false;
+    }
+  }
+
+  core.debug(`    all patterns matched all files`);
+  return true;
+}

src/labeler.ts

@@ -1,25 +1,41 @@
 import * as core from '@actions/core';
 import * as github from '@actions/github';
 import * as yaml from 'js-yaml';
-import {Minimatch, IMinimatch} from 'minimatch';
 
-interface MatchConfig {
-  all?: string[];
-  any?: string[];
-}
+import {
+  ChangedFilesMatchConfig,
+  getChangedFiles,
+  toChangedFilesMatchConfig,
+  checkAllChangedFiles,
+  checkAnyChangedFiles
+} from './changedFiles';
+import {
+  checkAnyBranch,
+  checkAllBranch,
+  toBranchMatchConfig,
+  BranchMatchConfig
+} from './branch';
+
+export type BaseMatchConfig = BranchMatchConfig & ChangedFilesMatchConfig;
+
+export type MatchConfig = {
+  any?: BaseMatchConfig[];
+  all?: BaseMatchConfig[];
+};
 
-type StringOrMatchConfig = string | MatchConfig;
 type ClientType = ReturnType<typeof github.getOctokit>;
 
+const ALLOWED_CONFIG_KEYS = ['changed-files', 'head-branch', 'base-branch'];
+
 export async function run() {
   try {
     const token = core.getInput('repo-token');
     const configPath = core.getInput('configuration-path', {required: true});
-    const syncLabels = !!core.getInput('sync-labels', {required: false});
+    const syncLabels = core.getBooleanInput('sync-labels');
 
     const prNumber = getPrNumber();
     if (!prNumber) {
-      console.log('Could not get pull request number from context, exiting');
+      core.info('Could not get pull request number from context, exiting');
       return;
     }
 
@@ -33,16 +49,16 @@ export async function run() {
 
     core.debug(`fetching changed files for pr #${prNumber}`);
     const changedFiles: string[] = await getChangedFiles(client, prNumber);
-    const labelGlobs: Map<string, StringOrMatchConfig[]> = await getLabelGlobs(
+    const labelConfigs: Map<string, MatchConfig[]> = await getMatchConfigs(
       client,
       configPath
     );
 
     const labels: string[] = [];
     const labelsToRemove: string[] = [];
-    for (const [label, globs] of labelGlobs.entries()) {
+    for (const [label, configs] of labelConfigs.entries()) {
       core.debug(`processing ${label}`);
-      if (checkGlobs(changedFiles, globs)) {
+      if (checkMatchConfigs(changedFiles, configs)) {
         labels.push(label);
       } else if (pullRequest.labels.find(l => l.name === label)) {
         labelsToRemove.push(label);
@@ -71,41 +87,20 @@ function getPrNumber(): number | undefined {
   return pullRequest.number;
 }
 
-async function getChangedFiles(
-  client: ClientType,
-  prNumber: number
-): Promise<string[]> {
-  const listFilesOptions = client.rest.pulls.listFiles.endpoint.merge({
-    owner: github.context.repo.owner,
-    repo: github.context.repo.repo,
-    pull_number: prNumber
-  });
-
-  const listFilesResponse = await client.paginate(listFilesOptions);
-  const changedFiles = listFilesResponse.map((f: any) => f.filename);
-
-  core.debug('found changed files:');
-  for (const file of changedFiles) {
-    core.debug('  ' + file);
-  }
-
-  return changedFiles;
-}
-
-async function getLabelGlobs(
+async function getMatchConfigs(
   client: ClientType,
   configurationPath: string
-): Promise<Map<string, StringOrMatchConfig[]>> {
+): Promise<Map<string, MatchConfig[]>> {
   const configurationContent: string = await fetchContent(
     client,
     configurationPath
   );
 
-  // loads (hopefully) a `{[label:string]: string | StringOrMatchConfig[]}`, but is `any`:
+  // loads (hopefully) a `{[label:string]: MatchConfig[]}`, but is `any`:
   const configObject: any = yaml.load(configurationContent);
 
-  // transform `any` => `Map<string,StringOrMatchConfig[]>` or throw if yaml is malformed:
-  return getLabelGlobMapFromObject(configObject);
+  // transform `any` => `Map<string,MatchConfig[]>` or throw if yaml is malformed:
+  return getLabelConfigMapFromObject(configObject);
 }
 
 async function fetchContent(
@@ -122,106 +117,101 @@ async function fetchContent(
   return Buffer.from(response.data.content, response.data.encoding).toString();
 }
 
-function getLabelGlobMapFromObject(
+export function getLabelConfigMapFromObject(
   configObject: any
-): Map<string, StringOrMatchConfig[]> {
-  const labelGlobs: Map<string, StringOrMatchConfig[]> = new Map();
+): Map<string, MatchConfig[]> {
+  const labelMap: Map<string, MatchConfig[]> = new Map();
   for (const label in configObject) {
-    if (typeof configObject[label] === 'string') {
-      labelGlobs.set(label, [configObject[label]]);
-    } else if (configObject[label] instanceof Array) {
-      labelGlobs.set(label, configObject[label]);
-    } else {
+    const configOptions = configObject[label];
+    if (
+      !Array.isArray(configOptions) ||
+      !configOptions.every(opts => typeof opts === 'object')
+    ) {
       throw Error(
-        `found unexpected type for label ${label} (should be string or array of globs)`
+        `found unexpected type for label '${label}' (should be array of config options)`
       );
     }
+    const matchConfigs = configOptions.reduce<MatchConfig[]>(
+      (updatedConfig, configValue) => {
+        if (!configValue) {
+          return updatedConfig;
         }
 
-  return labelGlobs;
+        Object.entries(configValue).forEach(([key, value]) => {
+          // If the top level `any` or `all` keys are provided then set them, and convert their values to
+          // our config objects.
+          if (key === 'any' || key === 'all') {
+            if (Array.isArray(value)) {
+              const newConfigs = value.map(toMatchConfig);
+              updatedConfig.push({[key]: newConfigs});
+            }
+          } else if (ALLOWED_CONFIG_KEYS.includes(key)) {
+            const newMatchConfig = toMatchConfig({[key]: value});
+            // Find or set the `any` key so that we can add these properties to that rule,
+            // Or create a new `any` key and add that to our array of configs.
+            const indexOfAny = updatedConfig.findIndex(mc => !!mc['any']);
+            if (indexOfAny >= 0) {
+              updatedConfig[indexOfAny].any?.push(newMatchConfig);
+            } else {
+              updatedConfig.push({any: [newMatchConfig]});
+            }
+          } else {
+            // Log the key that we don't know what to do with.
+            core.info(`An unknown config option was under ${label}: ${key}`);
+          }
+        });
+
+        return updatedConfig;
+      },
+      []
+    );
+
+    if (matchConfigs.length) {
+      labelMap.set(label, matchConfigs);
+    }
+  }
+
+  return labelMap;
 }
 
-function toMatchConfig(config: StringOrMatchConfig): MatchConfig {
-  if (typeof config === 'string') {
+export function toMatchConfig(config: any): BaseMatchConfig {
+  const changedFilesConfig = toChangedFilesMatchConfig(config);
+  const branchConfig = toBranchMatchConfig(config);
+
   return {
-      any: [config]
+    ...changedFilesConfig,
+    ...branchConfig
   };
-  }
-
-  return config;
 }
 
-function printPattern(matcher: IMinimatch): string {
-  return (matcher.negate ? '!' : '') + matcher.pattern;
-}
-
-export function checkGlobs(
+export function checkMatchConfigs(
   changedFiles: string[],
-  globs: StringOrMatchConfig[]
+  matchConfigs: MatchConfig[]
 ): boolean {
-  for (const glob of globs) {
-    core.debug(` checking pattern ${JSON.stringify(glob)}`);
-    const matchConfig = toMatchConfig(glob);
-    if (checkMatch(changedFiles, matchConfig)) {
-      return true;
-    }
-  }
-  return false;
-}
-
-function isMatch(changedFile: string, matchers: IMinimatch[]): boolean {
-  core.debug(`    matching patterns against file ${changedFile}`);
-  for (const matcher of matchers) {
-    core.debug(`   - ${printPattern(matcher)}`);
-    if (!matcher.match(changedFile)) {
-      core.debug(`   ${printPattern(matcher)} did not match`);
+  for (const config of matchConfigs) {
+    core.debug(` checking config ${JSON.stringify(config)}`);
+    if (!checkMatch(changedFiles, config)) {
       return false;
     }
   }
 
-  core.debug(`   all patterns matched`);
-  return true;
-}
-
-// equivalent to "Array.some()" but expanded for debugging and clarity
-function checkAny(changedFiles: string[], globs: string[]): boolean {
-  const matchers = globs.map(g => new Minimatch(g));
-  core.debug(`  checking "any" patterns`);
-  for (const changedFile of changedFiles) {
-    if (isMatch(changedFile, matchers)) {
-      core.debug(`  "any" patterns matched against ${changedFile}`);
-      return true;
-    }
-  }
-
-  core.debug(`  "any" patterns did not match any files`);
-  return false;
-}
-
-// equivalent to "Array.every()" but expanded for debugging and clarity
-function checkAll(changedFiles: string[], globs: string[]): boolean {
-  const matchers = globs.map(g => new Minimatch(g));
-  core.debug(` checking "all" patterns`);
-  for (const changedFile of changedFiles) {
-    if (!isMatch(changedFile, matchers)) {
-      core.debug(`  "all" patterns did not match against ${changedFile}`);
-      return false;
-    }
-  }
-
-  core.debug(`  "all" patterns matched all files`);
   return true;
 }
 
 function checkMatch(changedFiles: string[], matchConfig: MatchConfig): boolean {
-  if (matchConfig.all !== undefined) {
-    if (!checkAll(changedFiles, matchConfig.all)) {
+  if (!Object.keys(matchConfig).length) {
+    core.debug(`  no "any" or "all" patterns to check`);
+    return false;
+  }
+
+  if (matchConfig.all) {
+    if (!checkAll(matchConfig.all, changedFiles)) {
       return false;
     }
   }
 
-  if (matchConfig.any !== undefined) {
-    if (!checkAny(changedFiles, matchConfig.any)) {
+  if (matchConfig.any) {
+    if (!checkAny(matchConfig.any, changedFiles)) {
       return false;
     }
   }
@@ -229,6 +219,93 @@ function checkMatch(changedFiles: string[], matchConfig: MatchConfig): boolean {
   return true;
 }
 
+// equivalent to "Array.some()" but expanded for debugging and clarity
+export function checkAny(
+  matchConfigs: BaseMatchConfig[],
+  changedFiles: string[]
+): boolean {
+  core.debug(`  checking "any" patterns`);
+  if (
+    !matchConfigs.length ||
+    !matchConfigs.some(configOption => Object.keys(configOption).length)
+  ) {
+    core.debug(`  no "any" patterns to check`);
+    return false;
+  }
+
+  for (const matchConfig of matchConfigs) {
+    if (matchConfig.baseBranch) {
+      if (checkAnyBranch(matchConfig.baseBranch, 'base')) {
+        core.debug(`  "any" patterns matched`);
+        return true;
+      }
+    }
+
+    if (matchConfig.changedFiles) {
+      if (checkAnyChangedFiles(changedFiles, matchConfig.changedFiles)) {
+        core.debug(`  "any" patterns matched`);
+        return true;
+      }
+    }
+
+    if (matchConfig.headBranch) {
+      if (checkAnyBranch(matchConfig.headBranch, 'head')) {
+        core.debug(`  "any" patterns matched`);
+        return true;
+      }
+    }
+  }
+
+  core.debug(`  "any" patterns did not match any configs`);
+  return false;
+}
+
+// equivalent to "Array.every()" but expanded for debugging and clarity
+export function checkAll(
+  matchConfigs: BaseMatchConfig[],
+  changedFiles: string[]
+): boolean {
+  core.debug(`  checking "all" patterns`);
+  if (
+    !matchConfigs.length ||
+    !matchConfigs.some(configOption => Object.keys(configOption).length)
+  ) {
+    core.debug(`  no "all" patterns to check`);
+    return false;
+  }
+
+  for (const matchConfig of matchConfigs) {
+    if (matchConfig.baseBranch) {
+      if (!checkAllBranch(matchConfig.baseBranch, 'base')) {
+        core.debug(`  "all" patterns did not match`);
+        return false;
+      }
+    }
+
+    if (matchConfig.changedFiles) {
+      if (!changedFiles.length) {
+        core.debug(`  no files to check "changed-files" patterns against`);
+        return false;
+      }
+
+      if (!checkAllChangedFiles(changedFiles, matchConfig.changedFiles)) {
+        core.debug(`  "all" patterns did not match`);
+        return false;
+      }
+    }
+
+    if (matchConfig.headBranch) {
+      if (!checkAllBranch(matchConfig.headBranch, 'head')) {
+        core.debug(`  "all" patterns did not match`);
+        return false;
+      }
+    }
+  }
+
+  core.debug(`  "all" patterns matched all configs`);
+  return true;
+}
+
 async function addLabels(
   client: ClientType,
   prNumber: number,