Search for files matching glob patterns with support for returning matching deleted git tracked files, omits files and directories specified in the projects .gitignore, and excludes the .git and node_modules folders except explicitly specified.

• Usage
• Inputs
• Outputs
• Path filtering
  • minimatch options
    • Enabled
    • Optionally enabled
    • Disabled
  • Pattern Gotcha
• Patterns
  • Glob behavior
  • Tilde expansion
  • Comments
  • Exclude patterns
  • Escaping
• Credits
• Report Bugs

NOTE: ⚠️

• Ensure that subdirectory patterns are prefixed with **/ as **.yml only matches yml files in the top level directory and should be replaced with **/*.yml.
• All multi line string patterns are specified without quotes. See: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet for more examples of filter patterns

...
    steps:
      - uses: actions/checkout@v2

      - name: Glob match
        uses: tj-actions/glob@v17
        id: glob
        with:
          files: |
            *.md
            **/*.yaml
            !action.yml
            **/rebase.yml

      - name: Show all matching files
        run: |
          echo "${{ steps.glob.outputs.paths }}"
        # Outputs: .github/workflows/rebase.yml .github/workflows/sync-release-version.yml .github/workflows/test.yml...

File and Directory patterns are evaluted using minimatch with the help of the @actions/glob package.

• dot
• nocomment
• noext
• nonegate: This is handled by the @actions/glob package.

• nocase: Enabled for windows

• nobrace: Ensures that brace or brace sets can be used.

The ** pattern in 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 *, ?, [...], ** (globstar) are supported.

With the following behaviors:

• File names that begin with . may be included in the results
• Case insensitive on Windows
• Directory separator / and \ both supported on Windows

Supports basic tilde expansion, for current user HOME replacement only.

Example:

• ~ may expand to /Users/johndoe
• ~/foo may expand to /Users/johndoe/foo

Patterns that begin with # are treated as comments.

Leading ! changes the meaning of an include pattern to exclude.

Multiple leading ! flips the meaning.

Wrapping special characters in [] can be used to escape literal glob characters in a file name. For example the literal file name hello[a-z] can be escaped as hello[[]a-z].

On Linux/macOS \ is also treated as an escape character.

• Free software: MIT license

If you feel generous and want to show some extra appreciation:

This package was created with Cookiecutter using cookiecutter-action

• @actions/glob
• @actions/core
• @actions/exec
• @actions/github
• @actions/io

Report bugs at https://github.com/tj-actions/glob/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your workflow that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.