From fee9327009ff80c0a0d442f2204944771f0552b1 Mon Sep 17 00:00:00 2001 From: "tj-actions[bot]" <109116665+tj-actions-bot@users.noreply.github.com> Date: Tue, 6 Jun 2023 07:24:46 -0600 Subject: [PATCH] Updated README.md (#1232) Co-authored-by: jackton1 --- README.md | 62 +++++++++++++++++++++++++++---------------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index b4a10efd31c..017378a2055 100644 --- a/README.md +++ b/README.md @@ -201,37 +201,37 @@ 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 | `"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\_exclude\_root | string | false | `"false"` | Exclude the root 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 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\_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\_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. | -| 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. | -| 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 | | 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. | -| 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 files in
the `.github/outputs` folder by default. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|----------------------------------------------------------------------------------|--------|----------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 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\_exclude\_root~~
**Use `dir_names_exclude_current_dir` instead.** | string | false | `"false"` | **Deprecated:** Exclude the root 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 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\_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\_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. | +| 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. | +| 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 | | 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. | +| 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 files in
the `.github/outputs` folder by default. |