diff --git a/README.md b/README.md index 533e7be83..80abd5b55 100644 --- a/README.md +++ b/README.md @@ -64,29 +64,29 @@ Search for files matching [glob patterns](https://docs.github.com/en/actions/lea -| 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 set to `true` | -| base-sha | string | false | | Specify a base commit SHA
used for comparing changes, when
`include-deleted-files` is set to `true` | -| diff | string | false | | Specify a diff string `..`
or `...` used for comparing
changes, when `include-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-files` input | -| excluded-files-from-source-file-separator | string | false | `"\n"` | Separator used to split the
`excluded-files-from-source-file` input | -| excluded-files-separator | string | false | `"\n"` | Separator used to split the
`excluded-files` input | -| files | string | false | | File patterns | -| files-from-source-file | string | false | | Source file to populate the
`files` input | -| files-from-source-file-separator | string | false | `"\n"` | Separator used to split the
`files-from-source-file` input | -| files-separator | string | false | `"\n"` | Separator used to split the
`files` input | -| 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 set to `true` | -| include-deleted-files | string | false | `"false"` | Include all matching deleted files | -| match-directories | string | true | `"true"` | Indicates whether to include matched
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` is set to `true` | -| strip-top-level-dir | string | false | `"true"` | Strip the `$GITHUB_WORKSPACE` from the
`paths` output | -| working-directory | string | true | `"."` | Provide a path that is
relative to `$GITHUB_WORKSPACE` for identifying
the repository. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|----------|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| [base-ref](#input_base-ref) | string | false | `"${{ github.event.pull_request.base.ref }}"` | Specify a base ref used
for comparing changes, when `include-deleted-files`
is set to `true` | +| [base-sha](#input_base-sha) | string | false | | Specify a base commit SHA
used for comparing changes, when
`include-deleted-files` is set to `true` | +| [diff](#input_diff) | string | false | | Specify a diff string `..`
or `...` used for comparing
changes, when `include-deleted-files` is set
to `true` | +| [escape-paths](#input_escape-paths) | string | false | `"false"` | Escape special characters of filenames
used in the `paths` output | +| [excluded-files](#input_excluded-files) | string | false | | Excluded file patterns (optionally include `!` before the file pattern or it would be prepended) | +| [excluded-files-from-source-file](#input_excluded-files-from-source-file) | string | false | | Source file to populate the
`excluded-files` input | +| [excluded-files-from-source-file-separator](#input_excluded-files-from-source-file-separator) | string | false | `"\n"` | Separator used to split the
`excluded-files-from-source-file` input | +| [excluded-files-separator](#input_excluded-files-separator) | string | false | `"\n"` | Separator used to split the
`excluded-files` input | +| [files](#input_files) | string | false | | File patterns | +| [files-from-source-file](#input_files-from-source-file) | string | false | | Source file to populate the
`files` input | +| [files-from-source-file-separator](#input_files-from-source-file-separator) | string | false | `"\n"` | Separator used to split the
`files-from-source-file` input | +| [files-separator](#input_files-separator) | string | false | `"\n"` | Separator used to split the
`files` input | +| [follow-symbolic-links](#input_follow-symbolic-links) | string | true | `"true"` | Indicates whether to follow symbolic
links | +| [head-repo-fork](#input_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 set to `true` | +| [include-deleted-files](#input_include-deleted-files) | string | false | `"false"` | Include all matching deleted files | +| [match-directories](#input_match-directories) | string | true | `"true"` | Indicates whether to include matched
directories | +| [match-gitignore-files](#input_match-gitignore-files) | string | true | `"false"` | Indicates whether to match files
in `.gitignore` | +| [separator](#input_separator) | string | true | `" "` | Separator used for the paths
output. | +| [sha](#input_sha) | string | true | `"${{ github.sha }}"` | Specify a current commit SHA
used for comparing changes, when
`include-deleted-files` is set to `true` | +| [strip-top-level-dir](#input_strip-top-level-dir) | string | false | `"true"` | Strip the `$GITHUB_WORKSPACE` from the
`paths` output | +| [working-directory](#input_working-directory) | string | true | `"."` | Provide a path that is
relative to `$GITHUB_WORKSPACE` for identifying
the repository. | @@ -94,11 +94,11 @@ Search for files matching [glob patterns](https://docs.github.com/en/actions/lea -| OUTPUT | TYPE | DESCRIPTION | -|---------------------|--------|-------------------------------------------------------------------------------------------------------| -| has-custom-patterns | string | Indicates whether at least one
pattern was provided | -| 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 | +| OUTPUT | TYPE | DESCRIPTION | +|---------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------| +| [has-custom-patterns](#output_has-custom-patterns) | string | Indicates whether at least one
pattern was provided | +| [paths](#output_paths) | string | List of filtered paths using
the specified patterns and separator | +| [paths-output-file](#output_paths-output-file) | string | List of filtered paths using
the specified patterns and separator
stored in a temporary file |