diff --git a/README.md b/README.md index bc5bfcb6ccc..909f4c532aa 100644 --- a/README.md +++ b/README.md @@ -306,44 +306,44 @@ Support this project with a :star: -| 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` | +| 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.
*using 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. *using a combination of all added, copied, modified, renamed, and deleted files (ACMRD)*. | +| [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` | +| [only\_changed](#output_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](#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. *using 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` | @@ -351,55 +351,55 @@ Support this project with a :star: -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -|----------------------------------------------|--------|----------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| api\_url | string | false | `"${{ github.api_url }}"` | Github API URL. | -| 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\_include\_files | string | false | | Include files in the output
when `dir_names` is set to
`true`. **NOTE:** This returns only
the matching files and also
the directory names. | -| dir\_names\_include\_files\_separator | string | false | `"\n"` | Separator used to split the
`dir_names_include_files` input | -| 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\_additional\_submodule\_history | string | false | `"false"` | Fetch additional history for submodules. | -| 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 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. | -| old\_new\_separator | string | false | `","` | Split character for old and
new filename pairs. | -| 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` | -| recover\_deleted\_files | string | false | `"false"` | Recover deleted files. | -| recover\_deleted\_files\_to\_destination | string | false | | Recover deleted files to a
new destination directory, defaults to
the original location. | -| recover\_files | string | false | | File and directory patterns used
to recover deleted files, defaults
to the patterns provided via
the `files`, `files_from_source_file`, `files_ignore` and
`files_ignore_from_source_file` inputs or all deleted
files if no patterns are
provided. | -| recover\_files\_ignore | string | false | | File and directory patterns to
ignore when recovering deleted files. | -| recover\_files\_ignore\_separator | string | false | `"\n"` | Separator used to split the
`recover_files_ignore` input | -| recover\_files\_separator | string | false | `"\n"` | Separator used to split the
`recover_files` input | -| 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. | -| skip\_initial\_fetch | string | false | `"false"` | Skip the initial fetch to
improve performance for shallow repositories.
**NOTE**: This could lead to
errors with missing history and
the intended use is limited
to when you've fetched the
history necessary to perform the
diff. | -| token | string | false | `"${{ github.token }}"` | Github token used to fetch
changed files from Github's API. | -| 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`. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|----------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [api\_url](#input_api_url) | string | false | `"${{ github.api_url }}"` | Github API URL. | +| [base\_sha](#input_base_sha) | string | false | | Specify a different base commit
SHA used for comparing changes | +| [diff\_relative](#input_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](#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](#input_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\_include\_files](#input_dir_names_include_files) | string | false | | Include files in the output
when `dir_names` is set to
`true`. **NOTE:** This returns only
the matching files and also
the directory names. | +| [dir\_names\_include\_files\_separator](#input_dir_names_include_files_separator) | string | false | `"\n"` | Separator used to split the
`dir_names_include_files` input | +| [dir\_names\_max\_depth](#input_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](#input_escape_json) | string | false | `"true"` | Escape JSON output. | +| [fetch\_additional\_submodule\_history](#input_fetch_additional_submodule_history) | string | false | `"false"` | Fetch additional history for submodules. | +| [fetch\_depth](#input_fetch_depth) | string | false | `"50"` | Depth of additional branch history
fetched. **NOTE**: This can be
adjusted to resolve errors with
insufficient history. | +| [files](#input_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](#input_files_from_source_file) | string | false | | Source file(s) used to populate
the `files` input. | +| [files\_from\_source\_file\_separator](#input_files_from_source_file_separator) | string | false | `"\n"` | Separator used to split the
`files_from_source_file` input | +| [files\_ignore](#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](#input_files_ignore_from_source_file) | string | false | | Source file(s) used to populate
the `files_ignore` input | +| [files\_ignore\_from\_source\_file\_separator](#input_files_ignore_from_source_file_separator) | string | false | `"\n"` | Separator used to split the
`files_ignore_from_source_file` input | +| [files\_ignore\_separator](#input_files_ignore_separator) | string | false | `"\n"` | Separator used to split the
`files_ignore` input | +| [files\_ignore\_yaml](#input_files_ignore_yaml) | string | false | | YAML used to define a
set of file patterns to
ignore changes | +| [files\_ignore\_yaml\_from\_source\_file](#input_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](#input_files_ignore_yaml_from_source_file_separator) | string | false | `"\n"` | Separator used to split the
`files_ignore_yaml_from_source_file` input | +| [files\_separator](#input_files_separator) | string | false | `"\n"` | Separator used to split the
`files` input | +| [files\_yaml](#input_files_yaml) | string | false | | YAML used to define a
set of file patterns to
detect changes | +| [files\_yaml\_from\_source\_file](#input_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](#input_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](#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](#input_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](#input_old_new_files_separator) | string | false | `" "` | Split character for old and
new renamed filename pairs. | +| [old\_new\_separator](#input_old_new_separator) | string | false | `","` | Split character for old and
new filename pairs. | +| [output\_dir](#input_output_dir) | string | false | `".github/outputs"` | Directory to store output files. | +| [output\_renamed\_files\_as\_deleted\_and\_added](#input_output_renamed_files_as_deleted_and_added) | string | false | `"false"` | Output renamed files as deleted
and added files. | +| [path](#input_path) | string | false | `"."` | Specify a relative path under
`$GITHUB_WORKSPACE` to locate the repository. | +| [quotepath](#input_quotepath) | string | false | `"true"` | Use non-ascii characters to match
files and output the filenames
completely verbatim by setting this
to `false` | +| [recover\_deleted\_files](#input_recover_deleted_files) | string | false | `"false"` | Recover deleted files. | +| [recover\_deleted\_files\_to\_destination](#input_recover_deleted_files_to_destination) | string | false | | Recover deleted files to a
new destination directory, defaults to
the original location. | +| [recover\_files](#input_recover_files) | string | false | | File and directory patterns used
to recover deleted files, defaults
to the patterns provided via
the `files`, `files_from_source_file`, `files_ignore` and
`files_ignore_from_source_file` inputs or all deleted
files if no patterns are
provided. | +| [recover\_files\_ignore](#input_recover_files_ignore) | string | false | | File and directory patterns to
ignore when recovering deleted files. | +| [recover\_files\_ignore\_separator](#input_recover_files_ignore_separator) | string | false | `"\n"` | Separator used to split the
`recover_files_ignore` input | +| [recover\_files\_separator](#input_recover_files_separator) | string | false | `"\n"` | Separator used to split the
`recover_files` input | +| [separator](#input_separator) | string | false | `" "` | Split character for output strings | +| [sha](#input_sha) | string | false | | Specify a different commit SHA
used for comparing changes | +| [since](#input_since) | string | false | | Get changed files for commits
whose timestamp is older than
the given time. | +| [since\_last\_remote\_commit](#input_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. | +| [skip\_initial\_fetch](#input_skip_initial_fetch) | string | false | `"false"` | Skip the initial fetch to
improve performance for shallow repositories.
**NOTE**: This could lead to
errors with missing history and
the intended use is limited
to when you've fetched the
history necessary to perform the
diff. | +| [token](#input_token) | string | false | `"${{ github.token }}"` | Github token used to fetch
changed files from Github's API. | +| [until](#input_until) | string | false | | Get changed files for commits
whose timestamp is earlier than
the given time. | +| [write\_output\_files](#input_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`. |