Skip to content

Commit

Permalink
Merge pull request #884 from tj-actions/chore/update-readme
Browse files Browse the repository at this point in the history 
Updated README.md
  • Loading branch information
@repo-ranger
repo-ranger[bot] authored Aug 24, 2023
2 parents 80d9eeb + cf554ca commit cea6566
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,41 +64,41 @@ Search for files matching [glob patterns](https://docs.github.com/en/actions/lea

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-------------------------------------------|--------|----------|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| base-ref | string | false | `"${{ github.event.pull_request.base.ref }}"` | Specify a base ref used <br>for comparing changes, when `include-deleted-files` <br>is set to `true` |
| base-sha | string | false | | Specify a base commit SHA <br>used for comparing changes, when <br>`include-deleted-files` is set to `true` |
| diff | string | false | | Specify a diff string `..` <br>or `...` used for comparing <br>changes, when `include-deleted-files` is set <br>to `true` |
| escape-paths | string | false | `"false"` | Escape special characters of filenames <br>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 <br>`excluded-files` input |
| excluded-files-from-source-file-separator | string | false | `"\n"` | Separator used to split the <br>`excluded-files-from-source-file` input |
| excluded-files-separator | string | false | `"\n"` | Separator used to split the <br>`excluded-files` input |
| files | string | false | | File patterns |
| files-from-source-file | string | false | | Source file to populate the <br>`files` input |
| files-from-source-file-separator | string | false | `"\n"` | Separator used to split the <br>`files-from-source-file` input |
| files-separator | string | false | `"\n"` | Separator used to split the <br>`files` input |
| follow-symbolic-links | string | true | `"true"` | Indicates whether to follow symbolic <br>links |
| head-repo-fork | string | false | `"${{ github.event.pull_request.head.repo.fork }}"` | Specify a boolean indicating a <br>PR from a fork is <br>used for comparing changes, when <br>`include-deleted-files` is set to `true` |
| include-deleted-files | string | false | `"false"` | Include all matching deleted files |
| match-directories | string | true | `"true"` | Indicates whether to include matched <br>directories |
| match-gitignore-files | string | true | `"false"` | Indicates whether to match files <br>in `.gitignore` |
| separator | string | true | `" "` | Separator used for the paths <br>output. |
| sha | string | true | `"${{ github.sha }}"` | Specify a current commit SHA <br>used for comparing changes, when <br>`include-deleted-files` is set to `true` |
| strip-top-level-dir | string | false | `"true"` | Strip the `$GITHUB_WORKSPACE` from the <br>`paths` output |
| working-directory | string | true | `"."` | Provide a path that is <br>relative to `$GITHUB_WORKSPACE` for identifying <br>the repository. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|----------|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| <a name="input_base-ref"></a>[base-ref](#input_base-ref) | string | false | `"${{ github.event.pull_request.base.ref }}"` | Specify a base ref used <br>for comparing changes, when `include-deleted-files` <br>is set to `true` |
| <a name="input_base-sha"></a>[base-sha](#input_base-sha) | string | false | | Specify a base commit SHA <br>used for comparing changes, when <br>`include-deleted-files` is set to `true` |
| <a name="input_diff"></a>[diff](#input_diff) | string | false | | Specify a diff string `..` <br>or `...` used for comparing <br>changes, when `include-deleted-files` is set <br>to `true` |
| <a name="input_escape-paths"></a>[escape-paths](#input_escape-paths) | string | false | `"false"` | Escape special characters of filenames <br>used in the `paths` output |
| <a name="input_excluded-files"></a>[excluded-files](#input_excluded-files) | string | false | | Excluded file patterns (optionally include `!` before the file pattern or it would be prepended) |
| <a name="input_excluded-files-from-source-file"></a>[excluded-files-from-source-file](#input_excluded-files-from-source-file) | string | false | | Source file to populate the <br>`excluded-files` input |
| <a name="input_excluded-files-from-source-file-separator"></a>[excluded-files-from-source-file-separator](#input_excluded-files-from-source-file-separator) | string | false | `"\n"` | Separator used to split the <br>`excluded-files-from-source-file` input |
| <a name="input_excluded-files-separator"></a>[excluded-files-separator](#input_excluded-files-separator) | string | false | `"\n"` | Separator used to split the <br>`excluded-files` input |
| <a name="input_files"></a>[files](#input_files) | string | false | | File patterns |
| <a name="input_files-from-source-file"></a>[files-from-source-file](#input_files-from-source-file) | string | false | | Source file to populate the <br>`files` input |
| <a name="input_files-from-source-file-separator"></a>[files-from-source-file-separator](#input_files-from-source-file-separator) | string | false | `"\n"` | Separator used to split the <br>`files-from-source-file` input |
| <a name="input_files-separator"></a>[files-separator](#input_files-separator) | string | false | `"\n"` | Separator used to split the <br>`files` input |
| <a name="input_follow-symbolic-links"></a>[follow-symbolic-links](#input_follow-symbolic-links) | string | true | `"true"` | Indicates whether to follow symbolic <br>links |
| <a name="input_head-repo-fork"></a>[head-repo-fork](#input_head-repo-fork) | string | false | `"${{ github.event.pull_request.head.repo.fork }}"` | Specify a boolean indicating a <br>PR from a fork is <br>used for comparing changes, when <br>`include-deleted-files` is set to `true` |
| <a name="input_include-deleted-files"></a>[include-deleted-files](#input_include-deleted-files) | string | false | `"false"` | Include all matching deleted files |
| <a name="input_match-directories"></a>[match-directories](#input_match-directories) | string | true | `"true"` | Indicates whether to include matched <br>directories |
| <a name="input_match-gitignore-files"></a>[match-gitignore-files](#input_match-gitignore-files) | string | true | `"false"` | Indicates whether to match files <br>in `.gitignore` |
| <a name="input_separator"></a>[separator](#input_separator) | string | true | `" "` | Separator used for the paths <br>output. |
| <a name="input_sha"></a>[sha](#input_sha) | string | true | `"${{ github.sha }}"` | Specify a current commit SHA <br>used for comparing changes, when <br>`include-deleted-files` is set to `true` |
| <a name="input_strip-top-level-dir"></a>[strip-top-level-dir](#input_strip-top-level-dir) | string | false | `"true"` | Strip the `$GITHUB_WORKSPACE` from the <br>`paths` output |
| <a name="input_working-directory"></a>[working-directory](#input_working-directory) | string | true | `"."` | Provide a path that is <br>relative to `$GITHUB_WORKSPACE` for identifying <br>the repository. |

<!-- AUTO-DOC-INPUT:END -->

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

| OUTPUT | TYPE | DESCRIPTION |
|---------------------|--------|-------------------------------------------------------------------------------------------------------|
| has-custom-patterns | string | Indicates whether at least one <br>pattern was provided |
| paths | string | List of filtered paths using <br>the specified patterns and separator |
| paths-output-file | string | List of filtered paths using <br>the specified patterns and separator <br>stored in a temporary file |
| OUTPUT | TYPE | DESCRIPTION |
|---------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------|
| <a name="output_has-custom-patterns"></a>[has-custom-patterns](#output_has-custom-patterns) | string | Indicates whether at least one <br>pattern was provided |
| <a name="output_paths"></a>[paths](#output_paths) | string | List of filtered paths using <br>the specified patterns and separator |
| <a name="output_paths-output-file"></a>[paths-output-file](#output_paths-output-file) | string | List of filtered paths using <br>the specified patterns and separator <br>stored in a temporary file |

<!-- AUTO-DOC-OUTPUT:END -->

Expand Down

0 comments on commit cea6566

Please sign in to comment.