mirror of
https://github.com/actions/labeler.git
synced 2025-12-11 20:24:51 +00:00
Compare commits
1 Commits
v5.0.0-alp
...
update-cod
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4b5a5f236d |
@@ -1,7 +0,0 @@
|
|||||||
# Ignore list
|
|
||||||
/*
|
|
||||||
|
|
||||||
# Do not ignore these folders:
|
|
||||||
!__tests__/
|
|
||||||
!__mocks__/
|
|
||||||
!src/
|
|
||||||
50
.eslintrc.js
50
.eslintrc.js
@@ -1,50 +0,0 @@
|
|||||||
// 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
|
|
||||||
}
|
|
||||||
};
|
|
||||||
2
.gitattributes
vendored
2
.gitattributes
vendored
@@ -1,4 +1,4 @@
|
|||||||
* text=auto eol=lf
|
* text=auto
|
||||||
.licenses/** -diff linguist-generated=true
|
.licenses/** -diff linguist-generated=true
|
||||||
|
|
||||||
# don't diff machine generated files
|
# don't diff machine generated files
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Update the ${{ env.TAG_NAME }} tag
|
- name: Update the ${{ env.TAG_NAME }} tag
|
||||||
uses: actions/publish-action@v0.2.2
|
uses: actions/publish-action@v0.2.1
|
||||||
with:
|
with:
|
||||||
source-tag: ${{ env.TAG_NAME }}
|
source-tag: ${{ env.TAG_NAME }}
|
||||||
slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
|
slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
|
||||||
|
|||||||
11
.github/workflows/update-config-files.yml
vendored
11
.github/workflows/update-config-files.yml
vendored
@@ -1,11 +0,0 @@
|
|||||||
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
|
|
||||||
2
.licenses/npm/@actions/github.dep.yml
generated
2
.licenses/npm/@actions/github.dep.yml
generated
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: "@actions/github"
|
name: "@actions/github"
|
||||||
version: 5.1.1
|
version: 5.0.0
|
||||||
type: npm
|
type: npm
|
||||||
summary: Actions github lib
|
summary: Actions github lib
|
||||||
homepage: https://github.com/actions/toolkit/tree/main/packages/github
|
homepage: https://github.com/actions/toolkit/tree/main/packages/github
|
||||||
|
|||||||
32
.licenses/npm/@actions/http-client-1.0.11.dep.yml
generated
Normal file
32
.licenses/npm/@actions/http-client-1.0.11.dep.yml
generated
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
---
|
||||||
|
name: "@actions/http-client"
|
||||||
|
version: 1.0.11
|
||||||
|
type: npm
|
||||||
|
summary: Actions Http Client
|
||||||
|
homepage: https://github.com/actions/http-client#readme
|
||||||
|
license: mit
|
||||||
|
licenses:
|
||||||
|
- sources: LICENSE
|
||||||
|
text: |
|
||||||
|
Actions Http Client for Node.js
|
||||||
|
|
||||||
|
Copyright (c) GitHub, Inc.
|
||||||
|
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
||||||
|
associated documentation files (the "Software"), to deal in the Software without restriction,
|
||||||
|
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||||
|
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
||||||
|
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
|
||||||
|
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||||
|
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||||
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
notices: []
|
||||||
4
.licenses/npm/@octokit/auth-token.dep.yml
generated
4
.licenses/npm/@octokit/auth-token.dep.yml
generated
@@ -1,9 +1,9 @@
|
|||||||
---
|
---
|
||||||
name: "@octokit/auth-token"
|
name: "@octokit/auth-token"
|
||||||
version: 2.5.0
|
version: 2.4.5
|
||||||
type: npm
|
type: npm
|
||||||
summary: GitHub API token authentication for browsers and Node.js
|
summary: GitHub API token authentication for browsers and Node.js
|
||||||
homepage:
|
homepage: https://github.com/octokit/auth-token.js#readme
|
||||||
license: mit
|
license: mit
|
||||||
licenses:
|
licenses:
|
||||||
- sources: LICENSE
|
- sources: LICENSE
|
||||||
|
|||||||
2
.licenses/npm/@octokit/core.dep.yml
generated
2
.licenses/npm/@octokit/core.dep.yml
generated
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: "@octokit/core"
|
name: "@octokit/core"
|
||||||
version: 3.6.0
|
version: 3.5.1
|
||||||
type: npm
|
type: npm
|
||||||
summary: Extendable client for GitHub's REST & GraphQL APIs
|
summary: Extendable client for GitHub's REST & GraphQL APIs
|
||||||
homepage:
|
homepage:
|
||||||
|
|||||||
2
.licenses/npm/@octokit/graphql.dep.yml
generated
2
.licenses/npm/@octokit/graphql.dep.yml
generated
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: "@octokit/graphql"
|
name: "@octokit/graphql"
|
||||||
version: 4.8.0
|
version: 4.6.4
|
||||||
type: npm
|
type: npm
|
||||||
summary: GitHub GraphQL API client for browsers and Node
|
summary: GitHub GraphQL API client for browsers and Node
|
||||||
homepage:
|
homepage:
|
||||||
|
|||||||
4
.licenses/npm/@octokit/openapi-types.dep.yml
generated
4
.licenses/npm/@octokit/openapi-types.dep.yml
generated
@@ -1,8 +1,8 @@
|
|||||||
---
|
---
|
||||||
name: "@octokit/openapi-types"
|
name: "@octokit/openapi-types"
|
||||||
version: 12.11.0
|
version: 7.3.2
|
||||||
type: npm
|
type: npm
|
||||||
summary: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
|
summary: Generated TypeScript definitions based on GitHub's OpenAPI spec
|
||||||
homepage:
|
homepage:
|
||||||
license: mit
|
license: mit
|
||||||
licenses:
|
licenses:
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: "@octokit/plugin-paginate-rest"
|
name: "@octokit/plugin-paginate-rest"
|
||||||
version: 2.21.3
|
version: 2.13.5
|
||||||
type: npm
|
type: npm
|
||||||
summary: Octokit plugin to paginate REST API endpoint responses
|
summary: Octokit plugin to paginate REST API endpoint responses
|
||||||
homepage:
|
homepage:
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: "@octokit/plugin-rest-endpoint-methods"
|
name: "@octokit/plugin-rest-endpoint-methods"
|
||||||
version: 5.16.2
|
version: 5.3.1
|
||||||
type: npm
|
type: npm
|
||||||
summary: Octokit plugin adding one method for all of api.github.com REST API endpoints
|
summary: Octokit plugin adding one method for all of api.github.com REST API endpoints
|
||||||
homepage:
|
homepage:
|
||||||
|
|||||||
6
.licenses/npm/@octokit/request.dep.yml
generated
6
.licenses/npm/@octokit/request.dep.yml
generated
@@ -1,9 +1,9 @@
|
|||||||
---
|
---
|
||||||
name: "@octokit/request"
|
name: "@octokit/request"
|
||||||
version: 5.6.3
|
version: 5.6.0
|
||||||
type: npm
|
type: npm
|
||||||
summary: Send parameterized requests to GitHub's APIs with sensible defaults in browsers
|
summary: "Send parameterized requests to GitHubâ\x80\x99s APIs with sensible defaults
|
||||||
and Node
|
in browsers and Node"
|
||||||
homepage:
|
homepage:
|
||||||
license: mit
|
license: mit
|
||||||
licenses:
|
licenses:
|
||||||
|
|||||||
2
.licenses/npm/@octokit/types.dep.yml
generated
2
.licenses/npm/@octokit/types.dep.yml
generated
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: "@octokit/types"
|
name: "@octokit/types"
|
||||||
version: 6.41.0
|
version: 6.16.4
|
||||||
type: npm
|
type: npm
|
||||||
summary: Shared TypeScript definitions for Octokit projects
|
summary: Shared TypeScript definitions for Octokit projects
|
||||||
homepage:
|
homepage:
|
||||||
|
|||||||
2
.licenses/npm/balanced-match.dep.yml
generated
2
.licenses/npm/balanced-match.dep.yml
generated
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: balanced-match
|
name: balanced-match
|
||||||
version: 1.0.2
|
version: 1.0.0
|
||||||
type: npm
|
type: npm
|
||||||
summary: Match balanced character pairs, like "{" and "}"
|
summary: Match balanced character pairs, like "{" and "}"
|
||||||
homepage: https://github.com/juliangruber/balanced-match
|
homepage: https://github.com/juliangruber/balanced-match
|
||||||
|
|||||||
2
.licenses/npm/before-after-hook.dep.yml
generated
2
.licenses/npm/before-after-hook.dep.yml
generated
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: before-after-hook
|
name: before-after-hook
|
||||||
version: 2.2.3
|
version: 2.2.2
|
||||||
type: npm
|
type: npm
|
||||||
summary: asynchronous before/error/after hooks for internal functionality
|
summary: asynchronous before/error/after hooks for internal functionality
|
||||||
homepage:
|
homepage:
|
||||||
|
|||||||
2
.licenses/npm/brace-expansion.dep.yml
generated
2
.licenses/npm/brace-expansion.dep.yml
generated
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: brace-expansion
|
name: brace-expansion
|
||||||
version: 2.0.1
|
version: 1.1.11
|
||||||
type: npm
|
type: npm
|
||||||
summary: Brace expansion as known from sh/bash
|
summary: Brace expansion as known from sh/bash
|
||||||
homepage: https://github.com/juliangruber/brace-expansion
|
homepage: https://github.com/juliangruber/brace-expansion
|
||||||
|
|||||||
31
.licenses/npm/concat-map.dep.yml
generated
Normal file
31
.licenses/npm/concat-map.dep.yml
generated
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
---
|
||||||
|
name: concat-map
|
||||||
|
version: 0.0.1
|
||||||
|
type: npm
|
||||||
|
summary: concatenative mapdashery
|
||||||
|
homepage:
|
||||||
|
license: other
|
||||||
|
licenses:
|
||||||
|
- sources: LICENSE
|
||||||
|
text: |
|
||||||
|
This software is released under the MIT license:
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||||
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||||
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
- sources: README.markdown
|
||||||
|
text: MIT
|
||||||
|
notices: []
|
||||||
4
.licenses/npm/minimatch.dep.yml
generated
4
.licenses/npm/minimatch.dep.yml
generated
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
name: minimatch
|
name: minimatch
|
||||||
version: 7.4.3
|
version: 3.1.2
|
||||||
type: npm
|
type: npm
|
||||||
summary: a glob matcher in javascript
|
summary: a glob matcher in javascript
|
||||||
homepage:
|
homepage:
|
||||||
@@ -10,7 +10,7 @@ licenses:
|
|||||||
text: |
|
text: |
|
||||||
The ISC License
|
The ISC License
|
||||||
|
|
||||||
Copyright (c) 2011-2022 Isaac Z. Schlueter and Contributors
|
Copyright (c) Isaac Z. Schlueter and Contributors
|
||||||
|
|
||||||
Permission to use, copy, modify, and/or distribute this software for any
|
Permission to use, copy, modify, and/or distribute this software for any
|
||||||
purpose with or without fee is hereby granted, provided that the above
|
purpose with or without fee is hereby granted, provided that the above
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
# Ignore list
|
|
||||||
/*
|
|
||||||
|
|
||||||
# Do not ignore these folders:
|
|
||||||
!__tests__/
|
|
||||||
!__mocks__/
|
|
||||||
!.github/
|
|
||||||
!src/
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
// 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'
|
|
||||||
};
|
|
||||||
12
.prettierrc.json
Normal file
12
.prettierrc.json
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"printWidth": 80,
|
||||||
|
"tabWidth": 2,
|
||||||
|
"useTabs": false,
|
||||||
|
"semi": true,
|
||||||
|
"singleQuote": true,
|
||||||
|
"trailingComma": "none",
|
||||||
|
"bracketSpacing": false,
|
||||||
|
"arrowParens": "avoid",
|
||||||
|
"parser": "typescript",
|
||||||
|
"endOfLine": "auto"
|
||||||
|
}
|
||||||
@@ -1 +1,3 @@
|
|||||||
* @actions/setup-actions-team
|
* @actions/actions-runtime
|
||||||
|
* @actions/runner-images-team
|
||||||
|
|
||||||
|
|||||||
96
README.md
96
README.md
@@ -1,84 +1,66 @@
|
|||||||
# Pull Request Labeler
|
# Pull Request Labeler
|
||||||
|
|
||||||
[](https://github.com/actions/labeler/actions/workflows/basic-validation.yml)
|
<p align="left">
|
||||||
|
<a href="https://github.com/actions/labeler/actions?query=workflow%3A%22Build+%26+Test%22++">
|
||||||
|
<img alt="build and test status" src="https://github.com/actions/labeler/actions/workflows/build_test.yml/badge.svg">
|
||||||
|
</a>
|
||||||
|
<a href="https://david-dm.org/actions/labeler">
|
||||||
|
<img alt="dependencies" src="https://status.david-dm.org/gh/actions/labeler.svg">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
Automatically label new pull requests based on the paths of files being changed or the branch name.
|
Automatically label new pull requests based on the paths of files being changed.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Create `.github/labeler.yml`
|
### Create `.github/labeler.yml`
|
||||||
|
|
||||||
Create a `.github/labeler.yml` file with a list of labels and config options to match and apply the label.
|
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.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
#### Match Object
|
#### Match Object
|
||||||
|
|
||||||
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.
|
For more control over matching, you can provide a match object instead of a simple path glob. The match object is defined as:
|
||||||
|
|
||||||
The base match object is defined as:
|
|
||||||
```yml
|
```yml
|
||||||
- changed-files: ['list', 'of', 'globs']
|
- any: ['list', 'of', 'globs']
|
||||||
- base-branch: ['list', 'of', 'regexps']
|
all: ['list', 'of', 'globs']
|
||||||
- head-branch: ['list', 'of', 'regexps']
|
|
||||||
```
|
```
|
||||||
|
|
||||||
There are two top level keys of `any` and `all`, which both accept the same config options:
|
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.
|
||||||
```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:
|
The fields are defined as follows:
|
||||||
* `all`: all of the provided options must match in order for the label to be applied
|
* `any`: match ALL globs against ANY changed path
|
||||||
* `any`: if any of the provided options match then a label will be applied
|
* `all`: match ALL globs against ALL changed paths
|
||||||
* `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
|
|
||||||
|
|
||||||
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:
|
A simple path glob is the equivalent to `any: ['glob']`. More specifically, the following two configurations are equivalent:
|
||||||
```yml
|
```yml
|
||||||
label1:
|
label1:
|
||||||
- changed-files: example1/*
|
- example1/*
|
||||||
```
|
```
|
||||||
and
|
and
|
||||||
```yml
|
```yml
|
||||||
label1:
|
label1:
|
||||||
- any:
|
- any: ['example1/*']
|
||||||
- changed-files: ['example1/*']
|
|
||||||
```
|
```
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
#### Basic Examples
|
#### Basic Examples
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
# Add 'label1' to any changes within 'example' folder or any subfolders
|
# Add 'label1' to any changes within 'example' folder or any subfolders
|
||||||
label1:
|
label1:
|
||||||
- changed-files: example/**/*
|
- example/**/*
|
||||||
|
|
||||||
# Add 'label2' to any file changes within 'example2' folder
|
# Add 'label2' to any file changes within 'example2' folder
|
||||||
label2:
|
label2: example2/*
|
||||||
- changed-files: example2/*
|
|
||||||
|
|
||||||
# Add label3 to any change to .txt files within the entire repository. Quotation marks are required for the leading asterisk
|
# Add label3 to any change to .txt files within the entire repository. Quotation marks are required for the leading asterisk
|
||||||
label3:
|
label3:
|
||||||
- changed-files: '**/*.txt'
|
- '**/*.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
|
#### Common Examples
|
||||||
@@ -86,37 +68,25 @@ label5:
|
|||||||
```yml
|
```yml
|
||||||
# Add 'repo' label to any root file changes
|
# Add 'repo' label to any root file changes
|
||||||
repo:
|
repo:
|
||||||
- changed-files: '*'
|
- '*'
|
||||||
|
|
||||||
# Add '@domain/core' label to any change within the 'core' package
|
# Add '@domain/core' label to any change within the 'core' package
|
||||||
'@domain/core':
|
'@domain/core':
|
||||||
- changed-files:
|
|
||||||
- package/core/*
|
- package/core/*
|
||||||
- package/core/**/*
|
- package/core/**/*
|
||||||
|
|
||||||
# Add 'test' label to any change to *.spec.js files within the source dir
|
# Add 'test' label to any change to *.spec.js files within the source dir
|
||||||
test:
|
test:
|
||||||
- changed-files: src/**/*.spec.js
|
- src/**/*.spec.js
|
||||||
|
|
||||||
# Add 'source' label to any change to src files within the source dir EXCEPT for the docs sub-folder
|
# Add 'source' label to any change to src files within the source dir EXCEPT for the docs sub-folder
|
||||||
source:
|
source:
|
||||||
- changed-files:
|
|
||||||
- any: ['src/**/*', '!src/docs/*']
|
- any: ['src/**/*', '!src/docs/*']
|
||||||
|
|
||||||
# Add 'frontend` label to any change to *.js files as long as the `main.js` hasn't changed
|
# Add 'frontend` label to any change to *.js files as long as the `main.js` hasn't changed
|
||||||
frontend:
|
frontend:
|
||||||
- any:
|
- any: ['src/**/*.js']
|
||||||
- changed-files: ['src/**/*.js']
|
all: ['!src/main.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
|
### Create Workflow
|
||||||
@@ -135,18 +105,22 @@ jobs:
|
|||||||
pull-requests: write
|
pull-requests: write
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/labeler@v5
|
- uses: actions/labeler@v4
|
||||||
|
with:
|
||||||
|
repo-token: "${{ secrets.GITHUB_TOKEN }}"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
_Note: This grants access to the `GITHUB_TOKEN` so the action can make calls to GitHub's rest API_
|
||||||
|
|
||||||
#### Inputs
|
#### Inputs
|
||||||
|
|
||||||
Various inputs are defined in [`action.yml`](action.yml) to let you configure the labeler:
|
Various inputs are defined in [`action.yml`](action.yml) to let you configure the labeler:
|
||||||
|
|
||||||
| Name | Description | Default |
|
| Name | Description | Default |
|
||||||
| - | - | - |
|
| - | - | - |
|
||||||
| `repo-token` | Token to use to authorize label changes. Typically the GITHUB_TOKEN secret, with `contents:read` and `pull-requests:write` access | `github.token` |
|
| `repo-token` | Token to use to authorize label changes. Typically the GITHUB_TOKEN secret, with `contents:read` and `pull-requests:write` access | N/A |
|
||||||
| `configuration-path` | The path to the label configuration file | `.github/labeler.yml` |
|
| `configuration-path` | The path to the label configuration file | `.github/labeler.yml` |
|
||||||
| `sync-labels` | Whether or not to remove labels when matching files are reverted or no longer changed by the PR | `false`|
|
| `sync-labels` | Whether or not to remove labels when matching files are reverted or no longer changed by the PR | `false`
|
||||||
|
|
||||||
# Contributions
|
# Contributions
|
||||||
|
|
||||||
|
|||||||
@@ -1,13 +1,7 @@
|
|||||||
export const context = {
|
export const context = {
|
||||||
payload: {
|
payload: {
|
||||||
pull_request: {
|
pull_request: {
|
||||||
number: 123,
|
number: 123
|
||||||
head: {
|
|
||||||
ref: 'head-branch-name'
|
|
||||||
},
|
|
||||||
base: {
|
|
||||||
ref: 'base-branch-name'
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
repo: {
|
repo: {
|
||||||
|
|||||||
@@ -1,210 +0,0 @@
|
|||||||
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']
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
import {
|
|
||||||
ChangedFilesMatchConfig,
|
|
||||||
checkAllChangedFiles,
|
|
||||||
checkAnyChangedFiles,
|
|
||||||
toChangedFilesMatchConfig
|
|
||||||
} from '../src/changedFiles';
|
|
||||||
|
|
||||||
jest.mock('@actions/core');
|
|
||||||
jest.mock('@actions/github');
|
|
||||||
|
|
||||||
describe('checkAllChangedFiles', () => {
|
|
||||||
const changedFiles = ['foo.txt', 'bar.txt'];
|
|
||||||
|
|
||||||
describe('when the globs match every file that has been changed', () => {
|
|
||||||
const globs = ['*.txt'];
|
|
||||||
|
|
||||||
it('returns true', () => {
|
|
||||||
const result = checkAllChangedFiles(changedFiles, globs);
|
|
||||||
expect(result).toBe(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe(`when the globs don't match every file that has changed`, () => {
|
|
||||||
const globs = ['foo.txt'];
|
|
||||||
|
|
||||||
it('returns false', () => {
|
|
||||||
const result = checkAllChangedFiles(changedFiles, globs);
|
|
||||||
expect(result).toBe(false);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('checkAnyChangedFiles', () => {
|
|
||||||
const changedFiles = ['foo.txt', 'bar.txt'];
|
|
||||||
|
|
||||||
describe('when any glob matches any of the files that have changed', () => {
|
|
||||||
const globs = ['*.txt', '*.md'];
|
|
||||||
|
|
||||||
it('returns true', () => {
|
|
||||||
const result = checkAnyChangedFiles(changedFiles, globs);
|
|
||||||
expect(result).toBe(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('when none of the globs match any files that have changed', () => {
|
|
||||||
const globs = ['*.md'];
|
|
||||||
|
|
||||||
it('returns false', () => {
|
|
||||||
const result = checkAnyChangedFiles(changedFiles, globs);
|
|
||||||
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('and the value is an array of strings', () => {
|
|
||||||
const config = {'changed-files': ['testing']};
|
|
||||||
|
|
||||||
it('sets the value in the config object', () => {
|
|
||||||
const result = toChangedFilesMatchConfig(config);
|
|
||||||
expect(result).toEqual<ChangedFilesMatchConfig>({
|
|
||||||
changedFiles: ['testing']
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('and the value is a string', () => {
|
|
||||||
const config = {'changed-files': 'testing'};
|
|
||||||
|
|
||||||
it(`sets the string as an array in the config object`, () => {
|
|
||||||
const result = toChangedFilesMatchConfig(config);
|
|
||||||
expect(result).toEqual<ChangedFilesMatchConfig>({
|
|
||||||
changedFiles: ['testing']
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('but the value is an empty string', () => {
|
|
||||||
const config = {'changed-files': ''};
|
|
||||||
|
|
||||||
it(`returns an empty object`, () => {
|
|
||||||
const result = toChangedFilesMatchConfig(config);
|
|
||||||
expect(result).toEqual<ChangedFilesMatchConfig>({});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
describe('but the value is an empty array', () => {
|
|
||||||
const config = {'changed-files': []};
|
|
||||||
|
|
||||||
it(`returns an empty object`, () => {
|
|
||||||
const result = toChangedFilesMatchConfig(config);
|
|
||||||
expect(result).toEqual<ChangedFilesMatchConfig>({});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
label1:
|
|
||||||
- any:
|
|
||||||
- changed-files: ['glob']
|
|
||||||
- head-branch: ['regexp']
|
|
||||||
- base-branch: ['regexp']
|
|
||||||
- all:
|
|
||||||
- changed-files: ['glob']
|
|
||||||
- head-branch: ['regexp']
|
|
||||||
- base-branch: ['regexp']
|
|
||||||
|
|
||||||
label2:
|
|
||||||
- changed-files: ['glob']
|
|
||||||
- head-branch: ['regexp']
|
|
||||||
- base-branch: ['regexp']
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
tests:
|
|
||||||
- any:
|
|
||||||
- head-branch: ['^tests/', '^test/']
|
|
||||||
- changed-files: ['tests/**/*']
|
|
||||||
- all:
|
|
||||||
- changed-files: ['!tests/requirements.txt']
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
test-branch:
|
|
||||||
- head-branch: '^test/'
|
|
||||||
|
|
||||||
feature-branch:
|
|
||||||
- head-branch: '/feature/'
|
|
||||||
|
|
||||||
bug-branch:
|
|
||||||
- head-branch: '^bug/|fix/'
|
|
||||||
|
|
||||||
array-branch:
|
|
||||||
- head-branch: ['^array/']
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
label:
|
|
||||||
- all:
|
|
||||||
- unknown: 'this-is-not-supported'
|
|
||||||
@@ -1,2 +1,2 @@
|
|||||||
touched-a-pdf-file:
|
touched-a-pdf-file:
|
||||||
- changed-files: ['*.pdf']
|
- any: ['*.pdf']
|
||||||
|
|||||||
@@ -1,13 +1,6 @@
|
|||||||
import {
|
import {checkGlobs} from '../src/labeler';
|
||||||
checkMatchConfigs,
|
|
||||||
MatchConfig,
|
|
||||||
toMatchConfig,
|
|
||||||
getLabelConfigMapFromObject,
|
|
||||||
BaseMatchConfig
|
|
||||||
} from '../src/labeler';
|
|
||||||
import * as yaml from 'js-yaml';
|
|
||||||
import * as core from '@actions/core';
|
import * as core from '@actions/core';
|
||||||
import * as fs from 'fs';
|
|
||||||
|
|
||||||
jest.mock('@actions/core');
|
jest.mock('@actions/core');
|
||||||
|
|
||||||
@@ -17,124 +10,20 @@ beforeAll(() => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
const loadYaml = (filepath: string) => {
|
const matchConfig = [{any: ['*.txt']}];
|
||||||
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: ['glob']},
|
|
||||||
{baseBranch: undefined, headBranch: ['regexp']},
|
|
||||||
{baseBranch: ['regexp'], headBranch: undefined}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
all: [
|
|
||||||
{changedFiles: ['glob']},
|
|
||||||
{baseBranch: undefined, headBranch: ['regexp']},
|
|
||||||
{baseBranch: ['regexp'], headBranch: undefined}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]);
|
|
||||||
expected.set('label2', [
|
|
||||||
{
|
|
||||||
any: [
|
|
||||||
{changedFiles: ['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': ['testing-files'],
|
|
||||||
'head-branch': ['testing-head'],
|
|
||||||
'base-branch': ['testing-base']
|
|
||||||
};
|
|
||||||
const expected: BaseMatchConfig = {
|
|
||||||
changedFiles: ['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: ['*.txt']}]}];
|
|
||||||
|
|
||||||
|
describe('checkGlobs', () => {
|
||||||
it('returns true when our pattern does match changed files', () => {
|
it('returns true when our pattern does match changed files', () => {
|
||||||
const changedFiles = ['foo.txt', 'bar.txt'];
|
const changedFiles = ['foo.txt', 'bar.txt'];
|
||||||
const result = checkMatchConfigs(changedFiles, matchConfig);
|
const result = checkGlobs(changedFiles, matchConfig);
|
||||||
|
|
||||||
expect(result).toBeTruthy();
|
expect(result).toBeTruthy();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('returns false when our pattern does not match changed files', () => {
|
it('returns false when our pattern does not match changed files', () => {
|
||||||
const changedFiles = ['foo.docx'];
|
const changedFiles = ['foo.docx'];
|
||||||
const result = checkMatchConfigs(changedFiles, matchConfig);
|
const result = checkGlobs(changedFiles, matchConfig);
|
||||||
|
|
||||||
expect(result).toBeFalsy();
|
expect(result).toBeFalsy();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('returns true when either the branch or changed files patter matches', () => {
|
|
||||||
const matchConfig: MatchConfig[] = [
|
|
||||||
{any: [{changedFiles: ['*.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: ['*.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: ['*.txt']}]},
|
|
||||||
{any: [{headBranch: ['head-branch']}]}
|
|
||||||
];
|
|
||||||
const result = checkMatchConfigs(changedFiles, matchConfig);
|
|
||||||
expect(result).toBe(true);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -15,10 +15,7 @@ const paginateMock = jest.spyOn(gh, 'paginate');
|
|||||||
const getPullMock = jest.spyOn(gh.rest.pulls, 'get');
|
const getPullMock = jest.spyOn(gh.rest.pulls, 'get');
|
||||||
|
|
||||||
const yamlFixtures = {
|
const yamlFixtures = {
|
||||||
'branches.yml': fs.readFileSync('__tests__/fixtures/branches.yml'),
|
'only_pdfs.yml': fs.readFileSync('__tests__/fixtures/only_pdfs.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());
|
afterAll(() => jest.restoreAllMocks());
|
||||||
@@ -50,29 +47,16 @@ describe('run', () => {
|
|||||||
expect(addLabelsMock).toHaveBeenCalledTimes(0);
|
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 () => {
|
it('(with sync-labels: true) it deletes preexisting PR labels that no longer match the glob pattern', async () => {
|
||||||
const mockInput = {
|
let mockInput = {
|
||||||
'repo-token': 'foo',
|
'repo-token': 'foo',
|
||||||
'configuration-path': 'bar',
|
'configuration-path': 'bar',
|
||||||
'sync-labels': 'true'
|
'sync-labels': true
|
||||||
};
|
};
|
||||||
|
|
||||||
jest
|
jest
|
||||||
.spyOn(core, 'getInput')
|
.spyOn(core, 'getInput')
|
||||||
.mockImplementation((name: string, ...opts) => mockInput[name]);
|
.mockImplementation((name: string, ...opts) => mockInput[name]);
|
||||||
jest
|
|
||||||
.spyOn(core, 'getBooleanInput')
|
|
||||||
.mockImplementation(
|
|
||||||
(name: string, ...opts) => mockInput[name] === 'true'
|
|
||||||
);
|
|
||||||
|
|
||||||
usingLabelerConfigYaml('only_pdfs.yml');
|
usingLabelerConfigYaml('only_pdfs.yml');
|
||||||
mockGitHubResponseChangedFiles('foo.txt');
|
mockGitHubResponseChangedFiles('foo.txt');
|
||||||
@@ -95,20 +79,15 @@ 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 () => {
|
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 () => {
|
||||||
const mockInput = {
|
let mockInput = {
|
||||||
'repo-token': 'foo',
|
'repo-token': 'foo',
|
||||||
'configuration-path': 'bar',
|
'configuration-path': 'bar',
|
||||||
'sync-labels': 'false'
|
'sync-labels': false
|
||||||
};
|
};
|
||||||
|
|
||||||
jest
|
jest
|
||||||
.spyOn(core, 'getInput')
|
.spyOn(core, 'getInput')
|
||||||
.mockImplementation((name: string, ...opts) => mockInput[name]);
|
.mockImplementation((name: string, ...opts) => mockInput[name]);
|
||||||
jest
|
|
||||||
.spyOn(core, 'getBooleanInput')
|
|
||||||
.mockImplementation(
|
|
||||||
(name: string, ...opts) => mockInput[name] === 'true'
|
|
||||||
);
|
|
||||||
|
|
||||||
usingLabelerConfigYaml('only_pdfs.yml');
|
usingLabelerConfigYaml('only_pdfs.yml');
|
||||||
mockGitHubResponseChangedFiles('foo.txt');
|
mockGitHubResponseChangedFiles('foo.txt');
|
||||||
@@ -123,87 +102,6 @@ describe('run', () => {
|
|||||||
expect(addLabelsMock).toHaveBeenCalledTimes(0);
|
expect(addLabelsMock).toHaveBeenCalledTimes(0);
|
||||||
expect(removeLabelMock).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 {
|
function usingLabelerConfigYaml(fixtureName: keyof typeof yamlFixtures): void {
|
||||||
|
|||||||
@@ -3,9 +3,7 @@ description: 'Automatically label new pull requests based on the paths of files
|
|||||||
author: 'GitHub'
|
author: 'GitHub'
|
||||||
inputs:
|
inputs:
|
||||||
repo-token:
|
repo-token:
|
||||||
description: 'The GitHub token used to manage labels'
|
description: 'The GITHUB_TOKEN secret'
|
||||||
required: false
|
|
||||||
default: ${{ github.token }}
|
|
||||||
configuration-path:
|
configuration-path:
|
||||||
description: 'The path for the label configurations'
|
description: 'The path for the label configurations'
|
||||||
default: '.github/labeler.yml'
|
default: '.github/labeler.yml'
|
||||||
|
|||||||
4940
dist/index.js
vendored
4940
dist/index.js
vendored
File diff suppressed because one or more lines are too long
4350
package-lock.json
generated
4350
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
26
package.json
26
package.json
@@ -5,10 +5,9 @@
|
|||||||
"main": "lib/main.js",
|
"main": "lib/main.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc && ncc build lib/main.js",
|
"build": "tsc && ncc build lib/main.js",
|
||||||
"format": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --write \"**/*.{ts,yml,yaml}\"",
|
"format": "prettier --write **/*.ts",
|
||||||
"format-check": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --check \"**/*.{ts,yml,yaml}\"",
|
"format-check": "prettier --check **/*.ts",
|
||||||
"lint": "eslint --config ./.eslintrc.js \"**/*.ts\"",
|
"lint": "echo \"Fake command that does nothing. It is used in reusable workflows\"",
|
||||||
"lint:fix": "eslint --config ./.eslintrc.js \"**/*.ts\" --fix",
|
|
||||||
"test": "jest"
|
"test": "jest"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
@@ -25,24 +24,19 @@
|
|||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": "^1.10.0",
|
"@actions/core": "^1.10.0",
|
||||||
"@actions/github": "^5.1.1",
|
"@actions/github": "^5.0.0",
|
||||||
"js-yaml": "^4.1.0",
|
"js-yaml": "^4.1.0",
|
||||||
"minimatch": "^7.4.3"
|
"minimatch": "^3.0.4"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/jest": "^27.4.1",
|
"@types/jest": "^27.4.1",
|
||||||
"@types/js-yaml": "^4.0.5",
|
|
||||||
"@types/minimatch": "^5.1.2",
|
|
||||||
"@types/node": "^16.11.7",
|
"@types/node": "^16.11.7",
|
||||||
"@typescript-eslint/eslint-plugin": "^5.59.7",
|
"@types/minimatch": "^3.0.5",
|
||||||
"@typescript-eslint/parser": "^5.59.7",
|
"@types/js-yaml": "^4.0.5",
|
||||||
"@vercel/ncc": "^0.36.1",
|
"@vercel/ncc": "^0.34.0",
|
||||||
"eslint": "^8.41.0",
|
|
||||||
"eslint-config-prettier": "^8.8.0",
|
|
||||||
"eslint-plugin-jest": "^27.2.1",
|
|
||||||
"jest": "^27.5.1",
|
"jest": "^27.5.1",
|
||||||
"prettier": "^2.8.8",
|
"prettier": "^2.7.1",
|
||||||
"ts-jest": "^27.1.3",
|
"ts-jest": "^27.1.3",
|
||||||
"typescript": "^4.9.5"
|
"typescript": "^4.8.4"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,98 +0,0 @@
|
|||||||
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;
|
|
||||||
}
|
|
||||||
@@ -1,110 +0,0 @@
|
|||||||
import * as core from '@actions/core';
|
|
||||||
import * as github from '@actions/github';
|
|
||||||
import {Minimatch} from 'minimatch';
|
|
||||||
|
|
||||||
export interface ChangedFilesMatchConfig {
|
|
||||||
changedFiles?: string[];
|
|
||||||
}
|
|
||||||
|
|
||||||
type ClientType = ReturnType<typeof github.getOctokit>;
|
|
||||||
|
|
||||||
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 changedFilesConfig = config['changed-files'];
|
|
||||||
|
|
||||||
return {
|
|
||||||
changedFiles: Array.isArray(changedFilesConfig)
|
|
||||||
? changedFilesConfig
|
|
||||||
: [changedFilesConfig]
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function printPattern(matcher: Minimatch): string {
|
|
||||||
return (matcher.negate ? '!' : '') + matcher.pattern;
|
|
||||||
}
|
|
||||||
|
|
||||||
function isAnyMatch(changedFile: string, matchers: Minimatch[]): 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)} matched`);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
core.debug(` no patterns matched`);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
function isAllMatch(changedFile: string, matchers: Minimatch[]): 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`);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
core.debug(` all patterns matched`);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function checkAnyChangedFiles(
|
|
||||||
changedFiles: string[],
|
|
||||||
globs: string[]
|
|
||||||
): boolean {
|
|
||||||
const matchers = globs.map(g => new Minimatch(g));
|
|
||||||
for (const changedFile of changedFiles) {
|
|
||||||
if (isAnyMatch(changedFile, matchers)) {
|
|
||||||
core.debug(` "any" patterns matched against ${changedFile}`);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
core.debug(` "any" patterns did not match any files`);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function checkAllChangedFiles(
|
|
||||||
changedFiles: string[],
|
|
||||||
globs: string[]
|
|
||||||
): boolean {
|
|
||||||
const matchers = globs.map(g => new Minimatch(g));
|
|
||||||
for (const changedFile of changedFiles) {
|
|
||||||
if (!isAllMatch(changedFile, matchers)) {
|
|
||||||
core.debug(` "all" patterns did not match against ${changedFile}`);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
core.debug(` "all" patterns matched all files`);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
251
src/labeler.ts
251
src/labeler.ts
@@ -1,41 +1,25 @@
|
|||||||
import * as core from '@actions/core';
|
import * as core from '@actions/core';
|
||||||
import * as github from '@actions/github';
|
import * as github from '@actions/github';
|
||||||
import * as yaml from 'js-yaml';
|
import * as yaml from 'js-yaml';
|
||||||
|
import {Minimatch, IMinimatch} from 'minimatch';
|
||||||
|
|
||||||
import {
|
interface MatchConfig {
|
||||||
ChangedFilesMatchConfig,
|
all?: string[];
|
||||||
getChangedFiles,
|
any?: string[];
|
||||||
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>;
|
type ClientType = ReturnType<typeof github.getOctokit>;
|
||||||
|
|
||||||
const ALLOWED_CONFIG_KEYS = ['changed-files', 'head-branch', 'base-branch'];
|
|
||||||
|
|
||||||
export async function run() {
|
export async function run() {
|
||||||
try {
|
try {
|
||||||
const token = core.getInput('repo-token');
|
const token = core.getInput('repo-token', {required: true});
|
||||||
const configPath = core.getInput('configuration-path', {required: true});
|
const configPath = core.getInput('configuration-path', {required: true});
|
||||||
const syncLabels = core.getBooleanInput('sync-labels');
|
const syncLabels = !!core.getInput('sync-labels', {required: false});
|
||||||
|
|
||||||
const prNumber = getPrNumber();
|
const prNumber = getPrNumber();
|
||||||
if (!prNumber) {
|
if (!prNumber) {
|
||||||
core.info('Could not get pull request number from context, exiting');
|
console.log('Could not get pull request number from context, exiting');
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -49,16 +33,16 @@ export async function run() {
|
|||||||
|
|
||||||
core.debug(`fetching changed files for pr #${prNumber}`);
|
core.debug(`fetching changed files for pr #${prNumber}`);
|
||||||
const changedFiles: string[] = await getChangedFiles(client, prNumber);
|
const changedFiles: string[] = await getChangedFiles(client, prNumber);
|
||||||
const labelConfigs: Map<string, MatchConfig[]> = await getMatchConfigs(
|
const labelGlobs: Map<string, StringOrMatchConfig[]> = await getLabelGlobs(
|
||||||
client,
|
client,
|
||||||
configPath
|
configPath
|
||||||
);
|
);
|
||||||
|
|
||||||
const labels: string[] = [];
|
const labels: string[] = [];
|
||||||
const labelsToRemove: string[] = [];
|
const labelsToRemove: string[] = [];
|
||||||
for (const [label, configs] of labelConfigs.entries()) {
|
for (const [label, globs] of labelGlobs.entries()) {
|
||||||
core.debug(`processing ${label}`);
|
core.debug(`processing ${label}`);
|
||||||
if (checkMatchConfigs(changedFiles, configs)) {
|
if (checkGlobs(changedFiles, globs)) {
|
||||||
labels.push(label);
|
labels.push(label);
|
||||||
} else if (pullRequest.labels.find(l => l.name === label)) {
|
} else if (pullRequest.labels.find(l => l.name === label)) {
|
||||||
labelsToRemove.push(label);
|
labelsToRemove.push(label);
|
||||||
@@ -87,20 +71,41 @@ function getPrNumber(): number | undefined {
|
|||||||
return pullRequest.number;
|
return pullRequest.number;
|
||||||
}
|
}
|
||||||
|
|
||||||
async function getMatchConfigs(
|
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(
|
||||||
client: ClientType,
|
client: ClientType,
|
||||||
configurationPath: string
|
configurationPath: string
|
||||||
): Promise<Map<string, MatchConfig[]>> {
|
): Promise<Map<string, StringOrMatchConfig[]>> {
|
||||||
const configurationContent: string = await fetchContent(
|
const configurationContent: string = await fetchContent(
|
||||||
client,
|
client,
|
||||||
configurationPath
|
configurationPath
|
||||||
);
|
);
|
||||||
|
|
||||||
// loads (hopefully) a `{[label:string]: MatchConfig[]}`, but is `any`:
|
// loads (hopefully) a `{[label:string]: string | StringOrMatchConfig[]}`, but is `any`:
|
||||||
const configObject: any = yaml.load(configurationContent);
|
const configObject: any = yaml.load(configurationContent);
|
||||||
|
|
||||||
// transform `any` => `Map<string,MatchConfig[]>` or throw if yaml is malformed:
|
// transform `any` => `Map<string,StringOrMatchConfig[]>` or throw if yaml is malformed:
|
||||||
return getLabelConfigMapFromObject(configObject);
|
return getLabelGlobMapFromObject(configObject);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function fetchContent(
|
async function fetchContent(
|
||||||
@@ -117,186 +122,110 @@ async function fetchContent(
|
|||||||
return Buffer.from(response.data.content, response.data.encoding).toString();
|
return Buffer.from(response.data.content, response.data.encoding).toString();
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getLabelConfigMapFromObject(
|
function getLabelGlobMapFromObject(
|
||||||
configObject: any
|
configObject: any
|
||||||
): Map<string, MatchConfig[]> {
|
): Map<string, StringOrMatchConfig[]> {
|
||||||
const labelMap: Map<string, MatchConfig[]> = new Map();
|
const labelGlobs: Map<string, StringOrMatchConfig[]> = new Map();
|
||||||
for (const label in configObject) {
|
for (const label in configObject) {
|
||||||
const configOptions = configObject[label];
|
if (typeof configObject[label] === 'string') {
|
||||||
if (
|
labelGlobs.set(label, [configObject[label]]);
|
||||||
!Array.isArray(configOptions) ||
|
} else if (configObject[label] instanceof Array) {
|
||||||
!configOptions.every(opts => typeof opts === 'object')
|
labelGlobs.set(label, configObject[label]);
|
||||||
) {
|
} else {
|
||||||
throw Error(
|
throw Error(
|
||||||
`found unexpected type for label '${label}' (should be array of config options)`
|
`found unexpected type for label ${label} (should be string or array of globs)`
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
const matchConfigs = configOptions.reduce<MatchConfig[]>(
|
|
||||||
(updatedConfig, configValue) => {
|
|
||||||
if (!configValue) {
|
|
||||||
return updatedConfig;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Object.entries(configValue).forEach(([key, value]) => {
|
return labelGlobs;
|
||||||
// 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 {
|
return {
|
||||||
...changedFilesConfig,
|
any: [config]
|
||||||
...branchConfig
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export function checkMatchConfigs(
|
return config;
|
||||||
changedFiles: string[],
|
|
||||||
matchConfigs: MatchConfig[]
|
|
||||||
): boolean {
|
|
||||||
for (const config of matchConfigs) {
|
|
||||||
core.debug(` checking config ${JSON.stringify(config)}`);
|
|
||||||
if (!checkMatch(changedFiles, config)) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function printPattern(matcher: IMinimatch): string {
|
||||||
|
return (matcher.negate ? '!' : '') + matcher.pattern;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function checkGlobs(
|
||||||
|
changedFiles: string[],
|
||||||
|
globs: StringOrMatchConfig[]
|
||||||
|
): boolean {
|
||||||
|
for (const glob of globs) {
|
||||||
|
core.debug(` checking pattern ${JSON.stringify(glob)}`);
|
||||||
|
const matchConfig = toMatchConfig(glob);
|
||||||
|
if (checkMatch(changedFiles, matchConfig)) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
function checkMatch(changedFiles: string[], matchConfig: MatchConfig): boolean {
|
|
||||||
if (!Object.keys(matchConfig).length) {
|
|
||||||
core.debug(` no "any" or "all" patterns to check`);
|
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (matchConfig.all) {
|
function isMatch(changedFile: string, matchers: IMinimatch[]): boolean {
|
||||||
if (!checkAll(matchConfig.all, changedFiles)) {
|
core.debug(` matching patterns against file ${changedFile}`);
|
||||||
return false;
|
for (const matcher of matchers) {
|
||||||
}
|
core.debug(` - ${printPattern(matcher)}`);
|
||||||
}
|
if (!matcher.match(changedFile)) {
|
||||||
|
core.debug(` ${printPattern(matcher)} did not match`);
|
||||||
if (matchConfig.any) {
|
|
||||||
if (!checkAny(matchConfig.any, changedFiles)) {
|
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
core.debug(` all patterns matched`);
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
// equivalent to "Array.some()" but expanded for debugging and clarity
|
// equivalent to "Array.some()" but expanded for debugging and clarity
|
||||||
export function checkAny(
|
function checkAny(changedFiles: string[], globs: string[]): boolean {
|
||||||
matchConfigs: BaseMatchConfig[],
|
const matchers = globs.map(g => new Minimatch(g));
|
||||||
changedFiles: string[]
|
|
||||||
): boolean {
|
|
||||||
core.debug(` checking "any" patterns`);
|
core.debug(` checking "any" patterns`);
|
||||||
if (
|
for (const changedFile of changedFiles) {
|
||||||
!matchConfigs.length ||
|
if (isMatch(changedFile, matchers)) {
|
||||||
!matchConfigs.some(configOption => Object.keys(configOption).length)
|
core.debug(` "any" patterns matched against ${changedFile}`);
|
||||||
) {
|
|
||||||
core.debug(` no "any" patterns to check`);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const matchConfig of matchConfigs) {
|
|
||||||
if (matchConfig.baseBranch) {
|
|
||||||
if (checkAnyBranch(matchConfig.baseBranch, 'base')) {
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (matchConfig.changedFiles) {
|
core.debug(` "any" patterns did not match any files`);
|
||||||
if (checkAnyChangedFiles(changedFiles, matchConfig.changedFiles)) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (matchConfig.headBranch) {
|
|
||||||
if (checkAnyBranch(matchConfig.headBranch, 'head')) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
core.debug(` "any" patterns did not match any configs`);
|
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
// equivalent to "Array.every()" but expanded for debugging and clarity
|
// equivalent to "Array.every()" but expanded for debugging and clarity
|
||||||
export function checkAll(
|
function checkAll(changedFiles: string[], globs: string[]): boolean {
|
||||||
matchConfigs: BaseMatchConfig[],
|
const matchers = globs.map(g => new Minimatch(g));
|
||||||
changedFiles: string[]
|
|
||||||
): boolean {
|
|
||||||
core.debug(` checking "all" patterns`);
|
core.debug(` checking "all" patterns`);
|
||||||
if (
|
for (const changedFile of changedFiles) {
|
||||||
!matchConfigs.length ||
|
if (!isMatch(changedFile, matchers)) {
|
||||||
!matchConfigs.some(configOption => Object.keys(configOption).length)
|
core.debug(` "all" patterns did not match against ${changedFile}`);
|
||||||
) {
|
|
||||||
core.debug(` no "all" patterns to check`);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const matchConfig of matchConfigs) {
|
|
||||||
if (matchConfig.baseBranch) {
|
|
||||||
if (!checkAllBranch(matchConfig.baseBranch, 'base')) {
|
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (matchConfig.changedFiles) {
|
core.debug(` "all" patterns matched all files`);
|
||||||
if (!changedFiles.length) {
|
return true;
|
||||||
core.debug(` no files to check "changed-files" patterns against`);
|
|
||||||
return false;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!checkAllChangedFiles(changedFiles, matchConfig.changedFiles)) {
|
function checkMatch(changedFiles: string[], matchConfig: MatchConfig): boolean {
|
||||||
|
if (matchConfig.all !== undefined) {
|
||||||
|
if (!checkAll(changedFiles, matchConfig.all)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (matchConfig.headBranch) {
|
if (matchConfig.any !== undefined) {
|
||||||
if (!checkAllBranch(matchConfig.headBranch, 'head')) {
|
if (!checkAny(changedFiles, matchConfig.any)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
core.debug(` "all" patterns matched all configs`);
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user