fix!: replace custom glob with minimatch for improved pattern matching

[PendaGTP]

Description

Fixes #748

Replace custom glob implementation with minimatch.

Changes

• Replace custom glob implementation with minimatch to fully support glob patterns
• Remove support for Regex patterns
• Simplify logic for matching glob patterns
• Update and improve related documentation

⚠️ BREAKING CHANGES: ⚠️

Removed Regex support for patterns. Users must update their configuration to use glob syntax.

Before:

exclude: ['^admin$', '^\.github$', '^safe-settings$', '.*-test']

After:

restrictedRepos: ['admin', '.github', 'safe-settings', '*-test']

This change simplifies the configuration and doesn't significantly impact existing functionality.

Testing

• Ensured all unit tests pass
• Removed glob.test.ts as it's no longer necessary
• Performed minimal manual testing

[PendaGTP]

Note:

This PR doesn't impact:

• labels regex
• validator regex

[decyjphr]

This is great! But requires some manual resolution of conflicts. So will merge it after handling a few simpler PR merges.

[PendaGTP]

Let me know if (and when) you need help to resolve conflicts.

[decyjphr]

Thanks @PendaGTP if you could look at that it would be awesome. It is mostly the code you have contibuted in the previous PRs and this, so it would be easier for you.

[PendaGTP]

@decyjphr fyi rebase done

[bmike78]

I do want to comment that this fix by @PendaGTP works much better than the recent #808 merge when it comes to mistaken globbing issues.

Basically as it stands with current main-enterprise branch with #808, if there is a config like this:

suborgrepos:
  - luv

Then it will be greedy and pull in any repos that match "luv" in any part of the repo name, whereas in this PR, the behavior is that this config would only match the repo called "luv" and that's all.

Testing

• Tested globbing works, for example:

suborgrepos:
  - luv*

This will match any repo that starts with "luv", for example: "luv-mike-repo" will match.

• This did not seem to work:

suborgrepos:
  - *luv*

Our team is good with this behavior, just pointing out that we also tested this scenario.

Background

• About 7-8 months ago, we had a subort config with "admin" in the name that caused safe settings to deploy on several dozen repos that matched "admin" in any part of the repo name.
• Due to this, we diverged from the standard glob.js, but it looks like this PR will allow us to join back up with upstream safe settings once this PR is merged.

[decyjphr]

@PendaGTP wondering if you have seen this error before

ERROR (event): Cannot read properties of undefined (reading 'split')

Trying to test this before merging it.

[Copilot]

Pull Request Overview

Replace the custom glob implementation with minimatch-based matching and remove legacy regex support, updating all related logic, tests, and documentation.

• Swap custom Glob regex logic for minimatch in lib/glob.js and update callers
• Simplify include/exclude filtering in settings and plugin code
• Remove old glob tests, adjust config tests and documentation to use glob syntax

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
lib/glob.js	Replaced regex-based glob with minimatch calls
lib/settings.js	Updated includesRepo to use new Glob.test, fixed backward-compat logic and typo
lib/plugins/diffable.js	Simplified exclude/include filtering using Glob.test
index.js	Refactored file-matching functions to use glob patterns and removed inline regex
test/unit/lib/settings.test.js	Updated test patterns from regex to glob syntax
test/unit/lib/glob.test.ts	Removed obsolete custom glob tests—needs replacement
README.md	Updated usage docs to reflect glob-based patterns

Comments suppressed due to low confidence (4)

lib/settings.js:459

• Typo in log: "retricted" should be "restricted".

this.log.debug(`Skipping retricted repo ${repoName}`)

test/unit/lib/glob.test.ts:1

• All legacy glob tests were removed; add new unit tests to cover the updated Glob.test behavior against various glob patterns.

-const Glob = require('../../../lib/glob')

index.js:136

• [nitpick] This helper appears unused after the refactor in favor of getMatchingFiles–based functions. Remove or consolidate to avoid dead code.

function getAllChangedSubOrgConfigs (payload) {

lib/glob.js:1

• Destructuring minimatch like this will be undefined; require('minimatch') returns the function itself. Change to const minimatch = require('minimatch') or const { Minimatch } = require('minimatch') depending on usage.

const { minimatch } = require('minimatch')

[decyjphr]

LGTM