Assigns labels based on branch names

[joshdales]

Description:
Assign a label based on the branch name.

Depending on your branch name you may want to apply different labels based on the purpose of the branch. You can specify the base-branch or the head-branch that you wish to apply the labels based on. The config options for the branch can be listed as a string or an array of strings.

Puts all the branch matching, and changed files logic in their own files with some unit tests, and should hopefully create a good base for expanding with further options for matching options.

Related issues:

• Closes Apply labels based on branch name #186
• Closes Label PR based on base branch #54

Check list:

• Mark if documentation changes are required.
• Mark if tests were added or updated to cover the changes.

Breaking Changes:
Changes the config structure so that the any and all now have more options their original values are now under the changed-files key:

label:
  - 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']

If you omit a top level key it will default to any:

label:
  - changed-files: ['list', 'of', 'globs']
  - base-branch: ['list', 'of', 'regexps']
  - head-branch: ['list', 'of', 'regexps']

[amiel]

FYI: I found that this wasn't working for me as expected. I got it working for me in joshdales#1. I didn't spend much time writing up any context, partly because this PR doesn't have any response, so I'm not sure if anyone is planning to take the time to review this. I'd be happy to communicate more about it if there's interest.

EDIT: Updated PR reference.

[joshdales]

@amiel If it's not working properly I'm still interested so would appreciate any information you can give 😄

[amiel]

Hi @joshdales. I just realized that I referenced the wrong pull request in my last comment. I've edited it to reference the one I meant to reference: joshdales#1.

The problem I ran in to was that github.context.ref was producing something like refs/pull/23/head, which would not match my branch names like feature/foo.

Using github.context.payload.pull_request.head.ref resolves this for me and uses the branch name that I actually want to match on. I don't have a lot of experience with github actions, but I found this object path here: https://github.com/TimonVS/pr-labeler-action/blob/master/src/action.ts#L25.

[amiel]

I also considered updating your changes to support a list of branch patterns, just like the way lists of files are supported. However, I got it working by using the glob matching and I added a test to demonstrate that. This took me a little while to figure out because the minimatch documentation shows an example with (bar|foo), but I needed to use the glob syntax ({bar,foo}) instead.

[joshdales]

@amiel took your suggestion and I've updated this PR to support a list of branch arguments as well 👍

[amiel]

@joshdales Awesome! I'll pull those changes upstream too since we are pinned to our branch until this gets actually released.

[david-heward-unmind]

Be cool to get this feature shipped. I'd selfishly find it useful.

[MaksimZhukov]

Hi @joshdales and @lucacome! Sorry for the delay in responding!

We had a discussion within the team and we decided to follow your recommendations. Let's update the any selector to match any file against any glob pattern. We will release these changes as a new beta version so that users can test them and share their feedback. If they are satisfied with the new approach, we will release a stable version.

@joshdales please revert your recent changes. Sorry for going back and forth, and thank you for your time and efforts!

[joshdales]

@MaksimZhukov Changes reverted 👍

[MaksimZhukov]

Thank you @joshdales for the updates! Everything looks great, I left some minor comments

[lucacome]

I really didn't want to add another comment, but...seems like something is not working... 😭

with the same config as usual:

tests:
  - any:
      - head-branch: ['^tests/', '^test/']
      - changed-files: ['tests/**/*', 'perf-tests/**/*']
  - all:
      - changed-files: ['!tests/requirements.txt', '!perf-tests/requirements.txt']

I get

##[debug]processing tests
##[debug] checking config {"any":[{"headBranch":["^tests/","^test/"]},{"changedFiles":["tests/**/*","perf-tests/**/*"]}]}
##[debug]  checking "any" patterns
##[debug]   checking "branch" pattern against deps/foo
##[debug]    - /^tests\//
##[debug]    /^tests\// did not match
##[debug]    - /^test\//
##[debug]    /^test\// did not match
##[debug]   "branch" patterns did not match against deps/foo
##[debug]    matching patterns against file README.md
##[debug]     - tests/**/*
##[debug]     - perf-tests/**/*
##[debug]    no patterns matched
##[debug]    matching patterns against file tests/bar
##[debug]     - tests/**/*
##[debug]    tests/**/* matched
##[debug]   "any" patterns matched against tests/bar
##[debug] checking config {"all":[{"changedFiles":["!tests/requirements.txt","!perf-tests/requirements.txt"]}]}
##[debug]  checking "all" patterns
##[debug]  no "all" patterns to check

and the tests label is removed even tho "any" patterns matched against tests/bar.
It seems to me that is something with the "all" pattern from no "all" patterns to check.

[joshdales]

@lucacome I've pushed up a fix for this (and added a extra test based on your config so hopefully I don't accidentally break it again 🙈).

Thanks for your support with the testing comments - it has been much appreciated 🙏

[MaksimZhukov]

Hello everyone!
We released the new version of the action that includes these changes. For more information, see the release notes.

@joshdales thanks for working on this PR, for your time and contribution! It was a pleasure to work with you!
Thank you all for your comments and patience!