From e1754a427f478b8778d349341b8f1d80f1f47f44 Mon Sep 17 00:00:00 2001 From: "tj-actions[bot]" <109116665+tj-actions-bot@users.noreply.github.com> Date: Fri, 16 Jun 2023 21:30:45 -0600 Subject: [PATCH] Updated README.md (#1274) Co-authored-by: repo-ranger[bot] --- README.md | 61 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 38 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 0a660a3c..d569c552 100644 --- a/README.md +++ b/README.md @@ -208,29 +208,44 @@ 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 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). | +| OUTPUT | TYPE | DESCRIPTION | +|--------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| added\_files | string | Returns only files that are
Added (A). | +| added\_files\_count | string | Returns the number of `added_files` | +| all\_changed\_and\_modified\_files | string | Returns all changed and modified
files i.e. *a combination of (ACMRDTUX)* | +| all\_changed\_and\_modified\_files\_count | string | Returns the number of `all_changed_and_modified_files` | +| all\_changed\_files | string | Returns all changed files i.e.
*a combination of all added, copied, modified and renamed files (ACMR)* | +| all\_changed\_files\_count | string | Returns the number of `all_changed_files` | +| all\_modified\_files | string | Returns all changed files i.e.
*a combination of all added, copied, modified, renamed and deleted files (ACMRD)*. | +| all\_modified\_files\_count | string | Returns the number of `all_modified_files` | +| 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) | +| all\_old\_new\_renamed\_files\_count | string | Returns the number of `all_old_new_renamed_files` | +| 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). | +| copied\_files\_count | string | Returns the number of `copied_files` | +| deleted\_files | string | Returns only files that are
Deleted (D). | +| deleted\_files\_count | string | Returns the number of `deleted_files` | +| modified\_files | string | Returns only files that are
Modified (M). | +| modified\_files\_count | string | Returns the number of `modified_files` | +| 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\_changed\_files\_count | string | Returns the number of `other_changed_files` | +| 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\_deleted\_files\_count | string | Returns the number of `other_deleted_files` | +| 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)* | +| other\_modified\_files\_count | string | Returns the number of `other_modified_files` | +| renamed\_files | string | Returns only files that are
Renamed (R). | +| renamed\_files\_count | string | Returns the number of `renamed_files` | +| type\_changed\_files | string | Returns only files that have
their file type changed (T). | +| type\_changed\_files\_count | string | Returns the number of `type_changed_files` | +| unknown\_files | string | Returns only files that are
Unknown (X). | +| unknown\_files\_count | string | Returns the number of `unknown_files` | +| unmerged\_files | string | Returns only files that are
Unmerged (U). | +| unmerged\_files\_count | string | Returns the number of `unmerged_files` |