Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md #681

Merged
merged 1 commit into from
Mar 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,26 +83,23 @@ Search for files matching [glob patterns](https://docs.github.com/en/actions/lea
<!-- AUTO-DOC-OUTPUT:END -->

## Path filtering
- file and directory patterns are evaluted using [minimatch](https://github.com/isaacs/minimatch) with the help of the [@actions/glob](https://github.com/actions/toolkit/tree/main/packages/glob) package.

- Enabled [minimatch options](https://github.com/isaacs/minimatch#options)
- [dot](https://github.com/isaacs/minimatch#dot)
- [nocomment](https://github.com/isaacs/minimatch#nocomment)
- [noext](https://github.com/isaacs/minimatch#noext)
- [nonegate](https://github.com/isaacs/minimatch#nonegate): This is handled by the [@actions/glob](https://github.com/actions/toolkit/tree/main/packages/glob) package.
- Optionally enabled options
- [nocase](https://github.com/isaacs/minimatch#nobrace): Enabled for windows

- Disabled options
- [nobrace](https://github.com/isaacs/minimatch#nobrace): Ensures that brace or brace sets can be used.

* file and directory patterns are evaluted using [minimatch](https://github.com/isaacs/minimatch) with the help of the [@actions/glob](https://github.com/actions/toolkit/tree/main/packages/glob) package.

* Enabled [minimatch options](https://github.com/isaacs/minimatch#options)
* [dot](https://github.com/isaacs/minimatch#dot)
* [nocomment](https://github.com/isaacs/minimatch#nocomment)
* [noext](https://github.com/isaacs/minimatch#noext)
* [nonegate](https://github.com/isaacs/minimatch#nonegate): This is handled by the [@actions/glob](https://github.com/actions/toolkit/tree/main/packages/glob) package.
* Optionally enabled options
* [nocase](https://github.com/isaacs/minimatch#nobrace): Enabled for windows
* Disabled options
* [nobrace](https://github.com/isaacs/minimatch#nobrace): Ensures that brace or brace sets can be used.

### Pattern Gotcha

The `**` pattern in [minimatch](https://github.com/isaacs/minimatch) matches any number of directories and files recursively, but it must be followed by a directory separator (`/` on Unix-like systems) to be effective. If you want to match all files with the `.js` extension in a directory and its subdirectories, you should use the `**/*.js` pattern as opposed to `**.js`



## Patterns

### Glob behavior
Expand Down