diff --git a/README.md b/README.md index d3b9c9af..4d2718a8 100644 --- a/README.md +++ b/README.md @@ -343,52 +343,52 @@ Support this project with a :star: -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|----------------------------------------------|--------|----------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| api\_url | string | false | `"${{ github.api_url }}"` | Github API URL. | -| base\_sha | string | false | | Specify a different base commit
SHA used for comparing changes | -| diff\_relative | string | false | `"true"` | Exclude changes outside the current
directory and show path names
relative to it. **NOTE:** This
requires you to specify the
top level directory via the
`path` input. | -| dir\_names | string | false | `"false"` | Output unique changed directories instead
of filenames. **NOTE:** This returns
`.` for changed files located
in the current working directory
which defaults to `$GITHUB_WORKSPACE`. | -| dir\_names\_exclude\_current\_dir | string | false | `"false"` | Exclude the current directory represented
by `.` from the output
when `dir_names` is set to
`true`. | -| dir\_names\_max\_depth | string | false | | Limit the directory output to
a maximum depth e.g `test/test1/test2`
with max depth of `2`
returns `test/test1`. | -| escape\_json | string | false | `"true"` | Escape JSON output. | -| fetch\_depth | string | false | `"50"` | Depth of additional branch history
fetched. **NOTE**: This can be
adjusted to resolve errors with
insufficient history. | -| files | string | false | | File and directory patterns used
to detect changes (Defaults to the entire repo if unset) **NOTE:**
Multiline file/directory patterns should not
include quotes. | -| files\_from\_source\_file | string | false | | Source file(s) used to populate
the `files` input. | -| files\_from\_source\_file\_separator | string | false | `"\n"` | Separator used to split the
`files_from_source_file` input | -| files\_ignore | string | false | | Ignore changes to these file(s)
**NOTE:** Multiline file/directory patterns should
not include quotes. | -| files\_ignore\_from\_source\_file | string | false | | Source file(s) used to populate
the `files_ignore` input | -| files\_ignore\_from\_source\_file\_separator | string | false | `"\n"` | Separator used to split the
`files_ignore_from_source_file` input | -| files\_ignore\_separator | string | false | `"\n"` | Separator used to split the
`files_ignore` input | -| files\_ignore\_yaml | string | false | | YAML used to define a
set of file patterns to
ignore changes | -| files\_ignore\_yaml\_from\_source\_file | string | false | | Source file(s) used to populate
the `files_ignore_yaml` input. [Example](https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml) | -| files\_ignore\_yaml\_from\_source\_file\_separator | string | false | `"\n"` | Separator used to split the
`files_ignore_yaml_from_source_file` input | -| files\_separator | string | false | `"\n"` | Separator used to split the
`files` input | -| files\_yaml | string | false | | YAML used to define a
set of file patterns to
detect changes | -| files\_yaml\_from\_source\_file | string | false | | Source file(s) used to populate
the `files_yaml` input. [Example](https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml) | -| files\_yaml\_from\_source\_file\_separator | string | false | `"\n"` | Separator used to split the
`files_yaml_from_source_file` input | -| include\_all\_old\_new\_renamed\_files | string | false | `"false"` | Include `all_old_new_renamed_files` output. Note this
can generate a large output
See: [#501](https://github.com/tj-actions/changed-files/issues/501). | -| json | string | false | `"false"` | Output list of changed files
in a JSON formatted string
which can be used for
matrix jobs. | -| old\_new\_files\_separator | string | false | `" "` | Split character for old and
new renamed filename pairs. | -| old\_new\_separator | string | false | `","` | Split character for old and
new filename pairs. | -| output\_dir | string | false | `".github/outputs"` | Directory to store output files. | -| output\_renamed\_files\_as\_deleted\_and\_added | string | false | `"false"` | Output renamed files as deleted
and added files. | -| path | string | false | `"."` | Specify a relative path under
`$GITHUB_WORKSPACE` to locate the repository. | -| quotepath | string | false | `"true"` | Use non-ascii characters to match
files and output the filenames
completely verbatim by setting this
to `false` | -| recover\_deleted\_files | string | false | `"false"` | Recover deleted files. | -| recover\_deleted\_files\_to\_destination | string | false | | Recover deleted files to a
new destination directory, defaults to
the original location. | -| recover\_files | string | false | | File and directory patterns used
to recover deleted files. | -| recover\_files\_ignore | string | false | | File and directory patterns to
ignore when recovering deleted files. | -| recover\_files\_ignore\_separator | string | false | `"\n"` | Separator used to split the
`recover_files_ignore` input | -| recover\_files\_separator | string | false | `"\n"` | Separator used to split the
`recover_files` input | -| separator | string | false | `" "` | Split character for output strings | -| sha | string | false | | Specify a different commit SHA
used for comparing changes | -| since | string | false | | Get changed files for commits
whose timestamp is older than
the given time. | -| since\_last\_remote\_commit | string | false | `"false"` | Use the last commit on
the remote branch as the
`base_sha`. Defaults to the last
non-merge commit on the target
branch for pull request events
and the previous remote commit
of the current branch for
push events. | -| skip\_initial\_fetch | string | false | `"false"` | Skip the initial fetch to
improve performance for shallow repositories.
**NOTE**: This could lead to
errors with missing history and
the intended use is limited
to when you've fetched the
history necessary to perform the
diff. | -| token | string | false | `"${{ github.token }}"` | Github token used to fetch
changed files from Github's API. | -| until | string | false | | Get changed files for commits
whose timestamp is earlier than
the given time. | -| write\_output\_files | string | false | `"false"` | Write outputs to the `output_dir`
defaults to `.github/outputs` folder. **NOTE:**
This creates a `.txt` file
by default and a `.json`
file if `json` is set
to `true`. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|----------------------------------------------|--------|----------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| api\_url | string | false | `"${{ github.api_url }}"` | Github API URL. | +| base\_sha | string | false | | Specify a different base commit
SHA used for comparing changes | +| diff\_relative | string | false | `"true"` | Exclude changes outside the current
directory and show path names
relative to it. **NOTE:** This
requires you to specify the
top level directory via the
`path` input. | +| dir\_names | string | false | `"false"` | Output unique changed directories instead
of filenames. **NOTE:** This returns
`.` for changed files located
in the current working directory
which defaults to `$GITHUB_WORKSPACE`. | +| dir\_names\_exclude\_current\_dir | string | false | `"false"` | Exclude the current directory represented
by `.` from the output
when `dir_names` is set to
`true`. | +| dir\_names\_max\_depth | string | false | | Limit the directory output to
a maximum depth e.g `test/test1/test2`
with max depth of `2`
returns `test/test1`. | +| escape\_json | string | false | `"true"` | Escape JSON output. | +| fetch\_depth | string | false | `"50"` | Depth of additional branch history
fetched. **NOTE**: This can be
adjusted to resolve errors with
insufficient history. | +| files | string | false | | File and directory patterns used
to detect changes (Defaults to the entire repo if unset) **NOTE:**
Multiline file/directory patterns should not
include quotes. | +| files\_from\_source\_file | string | false | | Source file(s) used to populate
the `files` input. | +| files\_from\_source\_file\_separator | string | false | `"\n"` | Separator used to split the
`files_from_source_file` input | +| files\_ignore | string | false | | Ignore changes to these file(s)
**NOTE:** Multiline file/directory patterns should
not include quotes. | +| files\_ignore\_from\_source\_file | string | false | | Source file(s) used to populate
the `files_ignore` input | +| files\_ignore\_from\_source\_file\_separator | string | false | `"\n"` | Separator used to split the
`files_ignore_from_source_file` input | +| files\_ignore\_separator | string | false | `"\n"` | Separator used to split the
`files_ignore` input | +| files\_ignore\_yaml | string | false | | YAML used to define a
set of file patterns to
ignore changes | +| files\_ignore\_yaml\_from\_source\_file | string | false | | Source file(s) used to populate
the `files_ignore_yaml` input. [Example](https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml) | +| files\_ignore\_yaml\_from\_source\_file\_separator | string | false | `"\n"` | Separator used to split the
`files_ignore_yaml_from_source_file` input | +| files\_separator | string | false | `"\n"` | Separator used to split the
`files` input | +| files\_yaml | string | false | | YAML used to define a
set of file patterns to
detect changes | +| files\_yaml\_from\_source\_file | string | false | | Source file(s) used to populate
the `files_yaml` input. [Example](https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml) | +| files\_yaml\_from\_source\_file\_separator | string | false | `"\n"` | Separator used to split the
`files_yaml_from_source_file` input | +| include\_all\_old\_new\_renamed\_files | string | false | `"false"` | Include `all_old_new_renamed_files` output. Note this
can generate a large output
See: [#501](https://github.com/tj-actions/changed-files/issues/501). | +| json | string | false | `"false"` | Output list of changed files
in a JSON formatted string
which can be used for
matrix jobs. | +| old\_new\_files\_separator | string | false | `" "` | Split character for old and
new renamed filename pairs. | +| old\_new\_separator | string | false | `","` | Split character for old and
new filename pairs. | +| output\_dir | string | false | `".github/outputs"` | Directory to store output files. | +| output\_renamed\_files\_as\_deleted\_and\_added | string | false | `"false"` | Output renamed files as deleted
and added files. | +| path | string | false | `"."` | Specify a relative path under
`$GITHUB_WORKSPACE` to locate the repository. | +| quotepath | string | false | `"true"` | Use non-ascii characters to match
files and output the filenames
completely verbatim by setting this
to `false` | +| recover\_deleted\_files | string | false | `"false"` | Recover deleted files. | +| recover\_deleted\_files\_to\_destination | string | false | | Recover deleted files to a
new destination directory, defaults to
the original location. | +| recover\_files | string | false | | File and directory patterns used
to recover deleted files, defaults
to the patterns provided via
the `files`, `files_from_source_file`, `files_ignore` and
`files_ignore_from_source_file` inputs or all deleted
files if no patterns are
provided. | +| recover\_files\_ignore | string | false | | File and directory patterns to
ignore when recovering deleted files. | +| recover\_files\_ignore\_separator | string | false | `"\n"` | Separator used to split the
`recover_files_ignore` input | +| recover\_files\_separator | string | false | `"\n"` | Separator used to split the
`recover_files` input | +| separator | string | false | `" "` | Split character for output strings | +| sha | string | false | | Specify a different commit SHA
used for comparing changes | +| since | string | false | | Get changed files for commits
whose timestamp is older than
the given time. | +| since\_last\_remote\_commit | string | false | `"false"` | Use the last commit on
the remote branch as the
`base_sha`. Defaults to the last
non-merge commit on the target
branch for pull request events
and the previous remote commit
of the current branch for
push events. | +| skip\_initial\_fetch | string | false | `"false"` | Skip the initial fetch to
improve performance for shallow repositories.
**NOTE**: This could lead to
errors with missing history and
the intended use is limited
to when you've fetched the
history necessary to perform the
diff. | +| token | string | false | `"${{ github.token }}"` | Github token used to fetch
changed files from Github's API. | +| until | string | false | | Get changed files for commits
whose timestamp is earlier than
the given time. | +| write\_output\_files | string | false | `"false"` | Write outputs to the `output_dir`
defaults to `.github/outputs` folder. **NOTE:**
This creates a `.txt` file
by default and a `.json`
file if `json` is set
to `true`. |