diff --git a/README.md b/README.md index 411f954c..ca8cce9a 100644 --- a/README.md +++ b/README.md @@ -158,31 +158,31 @@ Support this project with a :star: -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|-----------------------------------|--------|----------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| base\_sha | string | false | | Specify a different base commit
SHA used for comparing changes
| -| diff\_relative | string | false | | 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 root of the
project. | -| dir\_names\_max\_depth | string | false | | Maximum depth of directories to
output. e.g `test/test1/test2` with max
depth of `2` returns `test/test1`.
| -| fetch\_depth | string | false | `"40"` | Initial depth of the branch
history fetched. **NOTE**: This can
be adjusted to resolve errors
with insufficient history. | -| files | string | false | | File and directory patterns to
detect changes using only these
list of file(s) (Defaults to
the entire repo) **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\_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\_separator | string | false | `"\n"` | Separator used to split the
`files-ignore` input | -| files\_separator | string | false | `"\n"` | Separator used to split the
`files` 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. | -| max\_fetch\_depth | string | false | `"5000"` | Maximum depth of the branch
history fetched. **NOTE**: This can
be adjusted to resolve errors
with insufficient history. | -| 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. | -| 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` | -| separator | string | false | `" "` | Split character for output strings
| -| sha | string | false | `"${{ github.sha }}"` | 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 | true | `"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 commit
of the current branch for
push events. | -| until | string | false | | Get changed files for commits
whose timestamp is earlier than
the given time. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|-----------------------------------|--------|----------|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| base\_sha | string | false | | Specify a different base commit
SHA used for comparing changes
| +| diff\_relative | string | false | | 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 root of the
project. | +| dir\_names\_max\_depth | string | false | | Maximum depth of directories to
output. e.g `test/test1/test2` with max
depth of `2` returns `test/test1`.
| +| fetch\_depth | string | false | `"40"` | Initial depth of the branch
history fetched. **NOTE**: This can
be adjusted to resolve errors
with insufficient history. | +| files | string | false | | File and directory patterns to
detect changes using only these
list of file(s) (Defaults to
the entire repo) **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\_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\_separator | string | false | `"\n"` | Separator used to split the
`files-ignore` input | +| files\_separator | string | false | `"\n"` | Separator used to split the
`files` 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. | +| max\_fetch\_depth | string | false | `"5000"` | Maximum depth of the branch
history fetched. **NOTE**: This can
be adjusted to resolve errors
with insufficient history. | +| 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. | +| 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` | +| separator | string | false | `" "` | Split character for output strings
| +| sha | string | false | `"${{ github.sha }}"` | 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 | true | `"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. | +| until | string | false | | Get changed files for commits
whose timestamp is earlier than
the given time. |