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 #682

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
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,24 @@ Search for files matching [glob patterns](https://docs.github.com/en/actions/lea

## Table of Contents

* [Usage](#usage)
* [Inputs](#inputs)
* [Outputs](#outputs)
* [Path filtering](#path-filtering)
* [minimatch options](#minimatch-options)
* [Enabled](#enabled)
* [Optionally enabled](#optionally-enabled)
* [Disabled](#disabled)
* [Pattern Gotcha](#pattern-gotcha)
* [Patterns](#patterns)
* [Glob behavior](#glob-behavior)
* [Tilde expansion](#tilde-expansion)
* [Comments](#comments)
* [Exclude patterns](#exclude-patterns)
* [Escaping](#escaping)
* [Credits](#credits)
* [Report Bugs](#report-bugs)

## Usage

> NOTE: :warning:
Expand Down Expand Up @@ -91,15 +109,18 @@ File and Directory patterns are evaluted using [minimatch](https://github.com/is
### [minimatch options](https://github.com/isaacs/minimatch#options)

#### Enabled

* [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

* [nocase](https://github.com/isaacs/minimatch#nobrace): Enabled for windows

#### Disabled

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

### Pattern Gotcha
Expand Down