diff --git a/README.md b/README.md index 948ae56fc45..88387256b0b 100644 --- a/README.md +++ b/README.md @@ -353,57 +353,58 @@ Support this project with a :star: -| 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. | -| [fail\_on\_initial\_diff\_error](#input_fail_on_initial_diff_error) | string | false | `"false"` | Fail when the initial diff
fails. | -| [fail\_on\_submodule\_diff\_error](#input_fail_on_submodule_diff_error) | string | false | `"false"` | Fail when the submodule diff
fails. | -| [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. [Example](https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-test.yml) | -| [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`. | +| 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\_deleted\_files\_include\_only\_deleted\_dirs](#input_dir_names_deleted_files_include_only_deleted_dirs) | string | false | `"false"` | Include only directories that have
been deleted as opposed to
directory names of files that
have been deleted in the
`deleted_files` output when `dir_names` is
set to `true`. | +| [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. | +| [fail\_on\_initial\_diff\_error](#input_fail_on_initial_diff_error) | string | false | `"false"` | Fail when the initial diff
fails. | +| [fail\_on\_submodule\_diff\_error](#input_fail_on_submodule_diff_error) | string | false | `"false"` | Fail when the submodule diff
fails. | +| [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. [Example](https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-test.yml) | +| [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`. |