diff --git a/README.md b/README.md index 6505316f..3f794584 100644 --- a/README.md +++ b/README.md @@ -205,29 +205,29 @@ Support this project with a :star: -| OUTPUT | TYPE | DESCRIPTION | -|--------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| added\_files | string | Returns only files that are
Added (A). | -| all\_changed\_and\_modified\_files | string | Returns all changed and modified
files i.e. *a combination of (ACMRDTUX)* | -| all\_changed\_files | string | Returns all changed files i.e.
*a combination of all added, copied, modified and renamed files (ACMR)* | -| all\_modified\_files | string | Returns all changed files i.e.
*a combination of all added, copied, modified, renamed and deleted files (ACMRD)*. | -| all\_old\_new\_renamed\_files | string | Returns only files that are
Renamed and list their old
and new names. **NOTE:** This
requires setting `include_all_old_new_renamed_files` to `true`
(R) | -| any\_changed | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has changed. i.e.
*using a combination of all added, copied, modified and renamed files (ACMR)*. | -| any\_deleted | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has been deleted.
(D) | -| any\_modified | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has been modified.
i.e. *using a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*. | -| copied\_files | string | Returns only files that are
Copied (C). | -| deleted\_files | string | Returns only files that are
Deleted (D). | -| modified\_files | string | Returns only files that are
Modified (M). | -| only\_changed | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has changed. i.e. *using a combination of all added, copied, modified and renamed files (ACMR)*. | -| only\_deleted | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has been deleted. (D) | -| only\_modified | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has been modified. (ACMRD). | -| other\_changed\_files | string | Returns all other changed files
not listed in the files
input i.e. *using a combination of all added, copied, modified and renamed files (ACMR)*. | -| other\_deleted\_files | string | Returns all other deleted files
not listed in the files
input i.e. *a combination of all deleted files (D)* | -| other\_modified\_files | string | Returns all other modified files
not listed in the files
input i.e. *a combination of all added, copied, modified, and deleted files (ACMRD)* | -| renamed\_files | string | Returns only files that are
Renamed (R). | -| type\_changed\_files | string | Returns only files that have
their file type changed (T). | -| unknown\_files | string | Returns only files that are
Unknown (X). | -| unmerged\_files | string | Returns only files that are
Unmerged (U). | +| OUTPUT | TYPE | DESCRIPTION | +|--------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| added\_files | string | Returns only files that are
Added (A). | +| all\_changed\_and\_modified\_files | string | Returns all changed and modified
files i.e. *a combination of (ACMRDTUX)* | +| all\_changed\_files | string | Returns all changed files i.e.
*a combination of all added, copied, modified and renamed files (ACMR)* | +| all\_modified\_files | string | Returns all changed files i.e.
*a combination of all added, copied, modified, renamed and deleted files (ACMRD)*. | +| all\_old\_new\_renamed\_files | string | Returns only files that are
Renamed and lists their old
and new names. **NOTE:** This
requires setting `include_all_old_new_renamed_files` to `true`.
Also, keep in mind that
this output is global and
wouldn't be nested in outputs
generated when the `*_yaml_*` input
is used. (R) | +| any\_changed | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has changed. i.e.
*using a combination of all added, copied, modified and renamed files (ACMR)*. | +| any\_deleted | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has been deleted.
(D) | +| any\_modified | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has been modified.
i.e. *using a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*. | +| copied\_files | string | Returns only files that are
Copied (C). | +| deleted\_files | string | Returns only files that are
Deleted (D). | +| modified\_files | string | Returns only files that are
Modified (M). | +| only\_changed | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has changed. i.e. *using a combination of all added, copied, modified and renamed files (ACMR)*. | +| only\_deleted | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has been deleted. (D) | +| only\_modified | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has been modified. (ACMRD). | +| other\_changed\_files | string | Returns all other changed files
not listed in the files
input i.e. *using a combination of all added, copied, modified and renamed files (ACMR)*. | +| other\_deleted\_files | string | Returns all other deleted files
not listed in the files
input i.e. *a combination of all deleted files (D)* | +| other\_modified\_files | string | Returns all other modified files
not listed in the files
input i.e. *a combination of all added, copied, modified, and deleted files (ACMRD)* | +| renamed\_files | string | Returns only files that are
Renamed (R). | +| type\_changed\_files | string | Returns only files that have
their file type changed (T). | +| unknown\_files | string | Returns only files that are
Unknown (X). | +| unmerged\_files | string | Returns only files that are
Unmerged (U). | @@ -245,14 +245,20 @@ Support this project with a :star: | 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 | 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. | @@ -260,11 +266,11 @@ Support this project with a :star: | 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` | +| 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. | +| 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 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`. |