From b5fc67a4f5e5dafd4d564eefde1958a4ae7974ac Mon Sep 17 00:00:00 2001 From: Tonye Jack Date: Mon, 27 Nov 2023 10:39:44 -0700 Subject: [PATCH] chore: update README.md (#1749) --- README.md | 119 +++++++++++++++++++++++++++--------------------------- 1 file changed, 60 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 9979f4b2..3b2b1088 100644 --- a/README.md +++ b/README.md @@ -296,69 +296,11 @@ Support this project with a :star: [buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png -## Useful Acronyms 🧮 - -| Acronym | Meaning | -|:---------:|:------------:| -| A | Added | -| C | Copied | -| M | Modified | -| D | Deleted | -| R | Renamed | -| T | Type changed | -| U | Unmerged | -| X | Unknown | - > **Warning** 🚨 > > * When using `files_yaml*` inputs ensure all outputs are prefixed by the key `test_{...}` e.g. `test_added_files`, `test_any_changed` > * All keys must start with a letter or \_ and contain only alphanumeric characters, -, or \_. -## Outputs 📤 - - - -| OUTPUT | TYPE | DESCRIPTION | -|------------------------------------------------------------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [added\_files](#output_added_files) | string | Returns only files that are
Added (A). | -| [added\_files\_count](#output_added_files_count) | string | Returns the number of `added_files` | -| [all\_changed\_and\_modified\_files](#output_all_changed_and_modified_files) | string | Returns all changed and modified
files i.e. *a combination of (ACMRDTUX)* | -| [all\_changed\_and\_modified\_files\_count](#output_all_changed_and_modified_files_count) | string | Returns the number of `all_changed_and_modified_files` | -| [all\_changed\_files](#output_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](#output_all_changed_files_count) | string | Returns the number of `all_changed_files` | -| [all\_modified\_files](#output_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](#output_all_modified_files_count) | string | Returns the number of `all_modified_files` | -| [all\_old\_new\_renamed\_files](#output_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](#output_all_old_new_renamed_files_count) | string | Returns the number of `all_old_new_renamed_files` | -| [any\_changed](#output_any_changed) | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has changed. i.e.
*includes a combination of all added, copied, modified and renamed files (ACMR)*. | -| [any\_deleted](#output_any_deleted) | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has been deleted.
(D) | -| [any\_modified](#output_any_modified) | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has been modified.
i.e. *includes a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*. | -| [changed\_keys](#output_changed_keys) | string | Returns all changed YAML keys
when the `files_yaml` input is
used. i.e. *key that contains any path that has either been added, copied, modified, and renamed (ACMR)* | -| [copied\_files](#output_copied_files) | string | Returns only files that are
Copied (C). | -| [copied\_files\_count](#output_copied_files_count) | string | Returns the number of `copied_files` | -| [deleted\_files](#output_deleted_files) | string | Returns only files that are
Deleted (D). | -| [deleted\_files\_count](#output_deleted_files_count) | string | Returns the number of `deleted_files` | -| [modified\_files](#output_modified_files) | string | Returns only files that are
Modified (M). | -| [modified\_files\_count](#output_modified_files_count) | string | Returns the number of `modified_files` | -| [modified\_keys](#output_modified_keys) | string | Returns all modified YAML keys
when the `files_yaml` input is
used. i.e. *key that contains any path that has either been added, copied, modified, and deleted (ACMRD)* | -| [only\_changed](#output_only_changed) | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*. | -| [only\_deleted](#output_only_deleted) | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has been deleted. (D) | -| [only\_modified](#output_only_modified) | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has been modified. (ACMRD). | -| [other\_changed\_files](#output_other_changed_files) | string | Returns all other changed files
not listed in the files
input i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*. | -| [other\_changed\_files\_count](#output_other_changed_files_count) | string | Returns the number of `other_changed_files` | -| [other\_deleted\_files](#output_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](#output_other_deleted_files_count) | string | Returns the number of `other_deleted_files` | -| [other\_modified\_files](#output_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](#output_other_modified_files_count) | string | Returns the number of `other_modified_files` | -| [renamed\_files](#output_renamed_files) | string | Returns only files that are
Renamed (R). | -| [renamed\_files\_count](#output_renamed_files_count) | string | Returns the number of `renamed_files` | -| [type\_changed\_files](#output_type_changed_files) | string | Returns only files that have
their file type changed (T). | -| [type\_changed\_files\_count](#output_type_changed_files_count) | string | Returns the number of `type_changed_files` | -| [unknown\_files](#output_unknown_files) | string | Returns only files that are
Unknown (X). | -| [unknown\_files\_count](#output_unknown_files_count) | string | Returns the number of `unknown_files` | -| [unmerged\_files](#output_unmerged_files) | string | Returns only files that are
Unmerged (U). | -| [unmerged\_files\_count](#output_unmerged_files_count) | string | Returns the number of `unmerged_files` | - ## Inputs ⚙️ @@ -654,6 +596,65 @@ Support this project with a :star: + +## Useful Acronyms 🧮 + +| Acronym | Meaning | +|:---------:|:------------:| +| A | Added | +| C | Copied | +| M | Modified | +| D | Deleted | +| R | Renamed | +| T | Type changed | +| U | Unmerged | +| X | Unknown | + +## Outputs 📤 + + + +| OUTPUT | TYPE | DESCRIPTION | +|------------------------------------------------------------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [added\_files](#output_added_files) | string | Returns only files that are
Added (A). | +| [added\_files\_count](#output_added_files_count) | string | Returns the number of `added_files` | +| [all\_changed\_and\_modified\_files](#output_all_changed_and_modified_files) | string | Returns all changed and modified
files i.e. *a combination of (ACMRDTUX)* | +| [all\_changed\_and\_modified\_files\_count](#output_all_changed_and_modified_files_count) | string | Returns the number of `all_changed_and_modified_files` | +| [all\_changed\_files](#output_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](#output_all_changed_files_count) | string | Returns the number of `all_changed_files` | +| [all\_modified\_files](#output_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](#output_all_modified_files_count) | string | Returns the number of `all_modified_files` | +| [all\_old\_new\_renamed\_files](#output_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](#output_all_old_new_renamed_files_count) | string | Returns the number of `all_old_new_renamed_files` | +| [any\_changed](#output_any_changed) | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has changed. i.e.
*includes a combination of all added, copied, modified and renamed files (ACMR)*. | +| [any\_deleted](#output_any_deleted) | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has been deleted.
(D) | +| [any\_modified](#output_any_modified) | string | Returns `true` when any of
the filenames provided using the
`files*` or `files_ignore*` inputs has been modified.
i.e. *includes a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*. | +| [changed\_keys](#output_changed_keys) | string | Returns all changed YAML keys
when the `files_yaml` input is
used. i.e. *key that contains any path that has either been added, copied, modified, and renamed (ACMR)* | +| [copied\_files](#output_copied_files) | string | Returns only files that are
Copied (C). | +| [copied\_files\_count](#output_copied_files_count) | string | Returns the number of `copied_files` | +| [deleted\_files](#output_deleted_files) | string | Returns only files that are
Deleted (D). | +| [deleted\_files\_count](#output_deleted_files_count) | string | Returns the number of `deleted_files` | +| [modified\_files](#output_modified_files) | string | Returns only files that are
Modified (M). | +| [modified\_files\_count](#output_modified_files_count) | string | Returns the number of `modified_files` | +| [modified\_keys](#output_modified_keys) | string | Returns all modified YAML keys
when the `files_yaml` input is
used. i.e. *key that contains any path that has either been added, copied, modified, and deleted (ACMRD)* | +| [only\_changed](#output_only_changed) | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has changed. i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*. | +| [only\_deleted](#output_only_deleted) | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has been deleted. (D) | +| [only\_modified](#output_only_modified) | string | Returns `true` when only files
provided using the `files*` or `files_ignore*` inputs
has been modified. (ACMRD). | +| [other\_changed\_files](#output_other_changed_files) | string | Returns all other changed files
not listed in the files
input i.e. *includes a combination of all added, copied, modified and renamed files (ACMR)*. | +| [other\_changed\_files\_count](#output_other_changed_files_count) | string | Returns the number of `other_changed_files` | +| [other\_deleted\_files](#output_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](#output_other_deleted_files_count) | string | Returns the number of `other_deleted_files` | +| [other\_modified\_files](#output_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](#output_other_modified_files_count) | string | Returns the number of `other_modified_files` | +| [renamed\_files](#output_renamed_files) | string | Returns only files that are
Renamed (R). | +| [renamed\_files\_count](#output_renamed_files_count) | string | Returns the number of `renamed_files` | +| [type\_changed\_files](#output_type_changed_files) | string | Returns only files that have
their file type changed (T). | +| [type\_changed\_files\_count](#output_type_changed_files_count) | string | Returns the number of `type_changed_files` | +| [unknown\_files](#output_unknown_files) | string | Returns only files that are
Unknown (X). | +| [unknown\_files\_count](#output_unknown_files_count) | string | Returns the number of `unknown_files` | +| [unmerged\_files](#output_unmerged_files) | string | Returns only files that are
Unmerged (U). | +| [unmerged\_files\_count](#output_unmerged_files_count) | string | Returns the number of `unmerged_files` | + ## Versioning 🏷️ This GitHub Action follows the principles of [Semantic Versioning](https://semver.org) for versioning releases. @@ -1172,7 +1173,7 @@ And many more... ## Important Notice ⚠️ -> **Important** : :bangbang: +> **Important** :bangbang: > > * Spaces in file names can introduce bugs when using bash loops. See: [#216](https://github.com/tj-actions/changed-files/issues/216) > However, this action will handle spaces in file names, with a recommendation of using a separator to prevent any hidden issues.