actions/labeler
1
0
Fork 0
mirror of https://github.com/actions/labeler.git synced 2025-12-13 04:57:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix "any" matching when not all globs match (#75)

Browse Source 
The previous logic had a bug where the "any" pattern list could match
against changed files even when not all globs matched a single changed
file. The bug arose individual globs in the "any" list were tested
against all changed files individually. Therefore, as long as at least
one changed file matched an individual glob in the list, a successful
match would be found.

The correct behavior is to match all the globs in the list against each
individual file. This ensures that is possible to define exlcusions
correctly and matched the documented behavior.
This commit is contained in:
Jameel Al-Aziz
2020-06-19 07:55:47 -07:00
committed by GitHub
parent 4b52aec09b
commit efc1b29f09
2 changed files with 83 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
dist/index.js vendored
View File

@@ -4207,6 +4207,9 @@ function toMatchConfig(config) {
} }
return config; return config;
} }
function printPattern(matcher) {
return (matcher.negate ? "!" : "") + matcher.pattern;
}
function checkGlobs(changedFiles, globs) { function checkGlobs(changedFiles, globs) {
for (const glob of globs) { for (const glob of globs) {
core.debug(` checking pattern ${JSON.stringify(glob)}`); core.debug(` checking pattern ${JSON.stringify(glob)}`);
@@ -4217,47 +4220,55 @@ function checkGlobs(changedFiles, globs) {
} }
return false; return false;
} }
function isMatch(changedFile, matchers) {
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;
}
// equivalent to "Array.some()" but expanded for debugging and clarity // equivalent to "Array.some()" but expanded for debugging and clarity
function checkAny(changedFiles, glob) { function checkAny(changedFiles, globs) {
core.debug(` checking "any" pattern ${glob}`); const matchers = globs.map(g => new minimatch_1.Minimatch(g));
const matcher = new minimatch_1.Minimatch(glob); core.debug(` checking "any" patterns`);
for (const changedFile of changedFiles) { for (const changedFile of changedFiles) {
core.debug(` - ${changedFile}`); if (isMatch(changedFile, matchers)) {
if (matcher.match(changedFile)) { core.debug(` "any" patterns matched against ${changedFile}`);
core.debug(` ${changedFile} matches`);
return true; return true;
} }
} }
core.debug(` "any" patterns did not match any files`);
return false; return false;
} }
// equivalent to "Array.every()" but expanded for debugging and clarity // equivalent to "Array.every()" but expanded for debugging and clarity
function checkAll(changedFiles, glob) { function checkAll(changedFiles, globs) {
core.debug(` checking "all" pattern ${glob}`); const matchers = globs.map(g => new minimatch_1.Minimatch(g));
const matcher = new minimatch_1.Minimatch(glob); core.debug(` checking "all" patterns`);
for (const changedFile of changedFiles) { for (const changedFile of changedFiles) {
core.debug(` - ${changedFile}`); if (!isMatch(changedFile, matchers)) {
if (!matcher.match(changedFile)) { core.debug(` "all" patterns did not match against ${changedFile}`);
core.debug(` ${changedFile} did not match`);
return false; return false;
} }
} }
core.debug(` "all" patterns matched all files`);
return true; return true;
} }
function checkMatch(changedFiles, matchConfig) { function checkMatch(changedFiles, matchConfig) {
if (matchConfig.all !== undefined) { if (matchConfig.all !== undefined) {
for (const glob of matchConfig.all) { if (!checkAll(changedFiles, matchConfig.all)) {
if (!checkAll(changedFiles, glob)) {
return false; return false;
} }
} }
}
if (matchConfig.any !== undefined) { if (matchConfig.any !== undefined) {
for (const glob of matchConfig.any) { if (!checkAny(changedFiles, matchConfig.any)) {
if (!checkAny(changedFiles, glob)) {
return false; return false;
} }
} }
}
return true; return true;
} }
function addLabels(client, prNumber, labels) { function addLabels(client, prNumber, labels) {

50
src/main.ts
View File

@@ -135,6 +135,10 @@ function toMatchConfig(config: StringOrMatchConfig): MatchConfig {
return config; return config;
} }
function printPattern(matcher: IMinimatch): string {
return (matcher.negate ? "!" : "") + matcher.pattern;
}
function checkGlobs( function checkGlobs(
changedFiles: string[], changedFiles: string[],
globs: StringOrMatchConfig[] globs: StringOrMatchConfig[]
@@ -149,52 +153,62 @@ function checkGlobs(
return false; 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`);
return false;
}
}
core.debug(` all patterns matched`);
return true;
}
// equivalent to "Array.some()" but expanded for debugging and clarity // equivalent to "Array.some()" but expanded for debugging and clarity
function checkAny(changedFiles: string[], glob: string): boolean { function checkAny(changedFiles: string[], globs: string[]): boolean {
core.debug(` checking "any" pattern ${glob}`); const matchers = globs.map(g => new Minimatch(g));
const matcher = new Minimatch(glob); core.debug(` checking "any" patterns`);
for (const changedFile of changedFiles) { for (const changedFile of changedFiles) {
core.debug(` - ${changedFile}`); if (isMatch(changedFile, matchers)) {
if (matcher.match(changedFile)) { core.debug(` "any" patterns matched against ${changedFile}`);
core.debug(` ${changedFile} matches`);
return true; return true;
} }
} }
core.debug(` "any" patterns did not match any files`);
return false; return false;
} }
// equivalent to "Array.every()" but expanded for debugging and clarity // equivalent to "Array.every()" but expanded for debugging and clarity
function checkAll(changedFiles: string[], glob: string): boolean { function checkAll(changedFiles: string[], globs: string[]): boolean {
core.debug(` checking "all" pattern ${glob}`); const matchers = globs.map(g => new Minimatch(g));
const matcher = new Minimatch(glob); core.debug(` checking "all" patterns`);
for (const changedFile of changedFiles) { for (const changedFile of changedFiles) {
core.debug(` - ${changedFile}`); if (!isMatch(changedFile, matchers)) {
if (!matcher.match(changedFile)) { core.debug(` "all" patterns did not match against ${changedFile}`);
core.debug(` ${changedFile} did not match`);
return false; return false;
} }
} }
core.debug(` "all" patterns matched all files`);
return true; return true;
} }
function checkMatch(changedFiles: string[], matchConfig: MatchConfig): boolean { function checkMatch(changedFiles: string[], matchConfig: MatchConfig): boolean {
if (matchConfig.all !== undefined) { if (matchConfig.all !== undefined) {
for (const glob of matchConfig.all) { if (!checkAll(changedFiles, matchConfig.all)) {
if (!checkAll(changedFiles, glob)) {
return false; return false;
} }
} }
}
if (matchConfig.any !== undefined) { if (matchConfig.any !== undefined) {
for (const glob of matchConfig.any) { if (!checkAny(changedFiles, matchConfig.any)) {
if (!checkAny(changedFiles, glob)) {
return false; return false;
} }
} }
}
return true; return true;
} }