Github action to match glob patterns with support for matching deleted files.
Search for files matching glob patterns with support for returning matching deleted git tracked files and also excludes all files and folders specified in .gitignore and the .git directory.
NOTE:
⚠️
- Ensure that subdirectory patterns are prefixed with
**/as**.ymlonly 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
...
steps:
- uses: actions/checkout@v2
- name: Glob match
uses: tj-actions/glob@v16
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...| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| base-ref | string | false | "${{ github.event.pull_request.base.ref }}" |
Specify a base ref used for comparing changes, when include-deleted-files is setto true |
| base-sha | string | false | Specify a base commit SHA used for comparing changes, when include-deleted-files isset to true |
|
| diff | string | false | Specify a diff string .. or... used for comparing changes, wheninclude-deleted-files is set to true |
|
| escape-paths | string | false | "false" |
Escape special characters of filenames used in the paths output |
| excluded-files | string | false | Excluded file patterns (optionally include !before the file pattern or it would be prepended) |
|
| excluded-files-from-source-file | string | false | Source file to populate the excluded-filesinput |
|
| excluded-files-from-source-file-separator | string | false | "\n" |
Separator used to split the excluded-files-from-source-fileinput |
| excluded-files-separator | string | false | "\n" |
Separator used to split the excluded-filesinput |
| files | string | false | File patterns | |
| files-from-source-file | string | false | Source file to populate the filesinput |
|
| files-from-source-file-separator | string | false | "\n" |
Separator used to split the files-from-source-fileinput |
| files-separator | string | false | "\n" |
Separator used to split the filesinput |
| follow-symbolic-links | string | true | "true" |
Indicates whether to follow symbolic links |
| head-repo-fork | string | false | "${{ github.event.pull_request.head.repo.fork }}" |
Specify a boolean indicating a PR from a fork is used for comparing changes, when include-deleted-files is setto true |
| include-deleted-files | string | false | "false" |
Include all matching deleted files |
| match-directories | string | true | "true" |
Indicates whether to include match directories |
| match-gitignore-files | string | true | "false" |
Indicates whether to match files in.gitignore |
| separator | string | true | " " |
Separator used for the paths output. |
| sha | string | true | "${{ github.sha }}" |
Specify a current commit SHA used for comparing changes, when include-deleted-files isset to true |
| strip-top-level-dir | string | false | "true" |
Strip the $GITHUB_WORKSPACE from the pathsoutput |
| working-directory | string | true | "." |
Specify a relative path under $GITHUB_WORKSPACE to locate the repository |
| OUTPUT | TYPE | DESCRIPTION |
|---|---|---|
| has-custom-patterns | string | Indicates whether custom patterns were used |
| paths | string | List of filtered paths using the specified patterns and separator |
| paths-output-file | string | List of filtered paths using the specified patterns and separator stored in a temporary file |
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~/foomay 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
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.