2022-04-08 09:43:01 +00:00
name : Changed Files
2023-06-19 15:48:20 +00:00
description : Get all Added, Copied, Modified, Deleted, Renamed, Type changed, Unmerged, and Unknown files.
2021-03-05 02:36:52 +00:00
author : tj-actions
2021-10-21 16:00:00 +00:00
2021-03-05 02:36:52 +00:00
inputs :
2021-03-05 12:25:17 +00:00
separator :
2022-06-12 14:08:13 +00:00
description : "Split character for output strings"
2022-05-14 18:33:40 +00:00
required : false
2021-03-05 12:25:17 +00:00
default : " "
2022-05-25 21:47:58 +00:00
include_all_old_new_renamed_files :
2022-10-29 21:48:36 +00:00
description : "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)."
2022-05-25 21:47:58 +00:00
required : false
2022-06-12 14:08:13 +00:00
default : "false"
2022-05-14 19:24:13 +00:00
old_new_separator :
2022-10-29 21:48:36 +00:00
description : "Split character for old and new filename pairs."
2022-05-14 18:33:40 +00:00
required : false
default : ","
2022-05-14 19:24:13 +00:00
old_new_files_separator :
2022-12-05 22:15:35 +00:00
description : "Split character for old and new renamed filename pairs."
2022-05-14 19:24:13 +00:00
required : false
default : " "
2021-07-17 15:46:59 +00:00
files_from_source_file :
2022-10-29 21:48:36 +00:00
description : "Source file(s) used to populate the `files` input."
2021-07-17 14:51:08 +00:00
required : false
default : ""
2023-05-25 18:22:24 +00:00
files_from_source_file_separator :
2023-05-25 20:33:08 +00:00
description : 'Separator used to split the `files_from_source_file` input'
2023-05-25 18:22:24 +00:00
default : "\n"
required : false
2021-04-30 16:04:23 +00:00
files :
2023-06-16 06:17:13 +00:00
description : "File and directory patterns used to detect changes (Defaults to the entire repo if unset) **NOTE:** Multiline file/directory patterns should not include quotes."
2021-04-30 16:04:23 +00:00
required : false
default : ""
2022-02-15 03:33:45 +00:00
files_separator :
2022-10-29 21:48:36 +00:00
description : "Separator used to split the `files` input"
2022-02-08 03:52:51 +00:00
default : "\n"
required : false
2023-06-16 06:17:13 +00:00
files_yaml :
description : "YAML used to define a set of file patterns to detect changes"
required : false
default : ""
files_yaml_from_source_file :
description : "Source file(s) used to populate the `files_yaml` input. [Example](https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml)"
required : false
default : ""
files_yaml_from_source_file_separator :
description : 'Separator used to split the `files_yaml_from_source_file` input'
default : "\n"
required : false
files_ignore_yaml :
description : "YAML used to define a set of file patterns to ignore changes"
required : false
default : ""
files_ignore_yaml_from_source_file :
description : "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)"
required : false
default : ""
files_ignore_yaml_from_source_file_separator :
description : 'Separator used to split the `files_ignore_yaml_from_source_file` input'
default : "\n"
required : false
2022-02-15 03:33:45 +00:00
files_ignore :
2022-12-05 06:06:33 +00:00
description : "Ignore changes to these file(s) **NOTE:** Multiline file/directory patterns should not include quotes."
2022-02-15 03:33:45 +00:00
required : false
default : ""
files_ignore_separator :
2022-12-15 20:10:14 +00:00
description : "Separator used to split the `files_ignore` input"
2022-02-15 03:33:45 +00:00
default : "\n"
required : false
files_ignore_from_source_file :
2022-10-29 21:48:36 +00:00
description : "Source file(s) used to populate the `files_ignore` input"
2022-02-15 03:33:45 +00:00
required : false
default : ""
2023-05-25 18:22:24 +00:00
files_ignore_from_source_file_separator :
description : 'Separator used to split the `files_ignore_from_source_file` input'
default : "\n"
required : false
2021-07-14 20:57:17 +00:00
sha :
2022-10-29 21:48:36 +00:00
description : "Specify a different commit SHA used for comparing changes"
2022-11-06 04:16:38 +00:00
required : false
2021-07-17 15:46:59 +00:00
base_sha :
2022-10-29 21:48:36 +00:00
description : "Specify a different base commit SHA used for comparing changes"
2021-07-17 15:46:59 +00:00
required : false
2022-08-21 02:23:21 +00:00
since :
2022-10-29 21:48:36 +00:00
description : "Get changed files for commits whose timestamp is older than the given time."
2022-08-21 02:23:21 +00:00
required : false
2022-09-07 15:43:10 +00:00
default : ""
2022-08-21 02:23:21 +00:00
until :
2022-10-29 21:48:36 +00:00
description : "Get changed files for commits whose timestamp is earlier than the given time."
2022-08-21 02:23:21 +00:00
required : false
2022-09-07 15:43:10 +00:00
default : ""
2021-08-28 01:53:03 +00:00
path :
2022-10-29 21:48:36 +00:00
description : "Specify a relative path under `$GITHUB_WORKSPACE` to locate the repository."
2021-08-28 01:53:03 +00:00
required : false
2022-06-12 14:08:13 +00:00
default : "."
2022-04-28 06:08:15 +00:00
quotepath :
2023-06-16 06:17:13 +00:00
description : "Use non-ascii characters to match files and output the filenames completely verbatim by setting this to `false`"
2022-06-12 14:08:13 +00:00
default : "true"
2022-04-28 06:08:15 +00:00
required : false
2022-06-02 16:13:45 +00:00
diff_relative :
2022-12-05 06:06:33 +00:00
description : "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."
2022-06-12 14:08:13 +00:00
required : false
2023-05-25 18:22:24 +00:00
default : "true"
2022-06-12 14:08:13 +00:00
dir_names :
default : "false"
2023-06-06 12:00:56 +00:00
description : "Output unique changed directories instead of filenames. **NOTE:** This returns `.` for changed files located in the current working directory which defaults to `$GITHUB_WORKSPACE`."
2022-06-02 16:13:45 +00:00
required : false
2022-11-24 00:25:26 +00:00
dir_names_max_depth :
2023-06-06 00:01:34 +00:00
description : "Limit the directory output to a maximum depth e.g `test/test1/test2` with max depth of `2` returns `test/test1`."
2022-11-24 00:25:26 +00:00
required : false
2023-06-06 12:00:56 +00:00
dir_names_exclude_current_dir :
description : "Exclude the current directory represented by `.` from the output when `dir_names` is set to `true`."
required : false
default : "false"
2022-08-03 20:01:40 +00:00
json :
2022-10-29 21:48:36 +00:00
description : "Output list of changed files in a JSON formatted string which can be used for matrix jobs."
2022-08-03 20:01:40 +00:00
required : false
default : "false"
2023-05-25 18:22:24 +00:00
escape_json :
description : "Escape JSON output."
2022-12-30 05:27:08 +00:00
required : false
2023-05-25 18:22:24 +00:00
default : "true"
2022-11-03 12:31:50 +00:00
fetch_depth :
2022-12-19 05:12:33 +00:00
description : "Depth of additional branch history fetched. **NOTE**: This can be adjusted to resolve errors with insufficient history."
2022-10-12 18:39:24 +00:00
required : false
2022-12-14 15:49:41 +00:00
default : "50"
2022-11-07 02:50:53 +00:00
since_last_remote_commit :
2023-06-16 06:17:13 +00:00
description : "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."
2023-01-10 19:38:39 +00:00
required : false
2022-11-07 02:50:53 +00:00
default : "false"
2022-12-19 17:51:22 +00:00
write_output_files :
2023-06-10 17:02:12 +00:00
description : "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`."
2022-12-19 17:51:22 +00:00
required : false
default : "false"
output_dir :
description : "Directory to store output files."
required : false
default : ".github/outputs"
2023-06-14 19:59:31 +00:00
output_renamed_files_as_deleted_and_added :
description : "Output renamed files as deleted and added files."
required : false
default : "false"
2023-06-17 00:57:12 +00:00
recover_deleted_files :
description : "Recover deleted files."
required : false
default : "false"
recover_deleted_files_to_destination :
description : "Recover deleted files to a new destination directory, defaults to the original location."
required : false
default : ""
2023-06-23 17:20:13 +00:00
token :
description : "Github token used to fetch changed files from Github's API."
required : false
default : ${{ github.token }}
api_url :
description : "Github API URL."
required : false
default : ${{ github.api_url }}
2021-03-05 12:25:17 +00:00
2021-03-05 03:43:17 +00:00
outputs :
added_files :
2022-10-29 21:48:36 +00:00
description : "Returns only files that are Added (A)."
2023-06-17 03:13:40 +00:00
added_files_count :
description : "Returns the number of `added_files`"
2021-03-05 03:43:17 +00:00
copied_files :
2022-10-29 21:48:36 +00:00
description : "Returns only files that are Copied (C)."
2023-06-17 03:13:40 +00:00
copied_files_count :
description : "Returns the number of `copied_files`"
2021-03-05 03:43:17 +00:00
deleted_files :
2022-10-29 21:48:36 +00:00
description : "Returns only files that are Deleted (D)."
2023-06-17 03:13:40 +00:00
deleted_files_count :
description : "Returns the number of `deleted_files`"
2021-03-05 03:43:17 +00:00
modified_files :
2022-10-29 21:48:36 +00:00
description : "Returns only files that are Modified (M)."
2023-06-17 03:13:40 +00:00
modified_files_count :
description : "Returns the number of `modified_files`"
2021-03-05 03:43:17 +00:00
renamed_files :
2022-10-29 21:48:36 +00:00
description : "Returns only files that are Renamed (R)."
2023-06-17 03:13:40 +00:00
renamed_files_count :
description : "Returns the number of `renamed_files`"
2022-05-14 21:54:38 +00:00
all_old_new_renamed_files :
2023-06-16 06:17:13 +00:00
description : "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)"
2023-06-17 03:13:40 +00:00
all_old_new_renamed_files_count :
description : "Returns the number of `all_old_new_renamed_files`"
2021-06-18 23:28:02 +00:00
type_changed_files :
2022-10-29 21:48:36 +00:00
description : "Returns only files that have their file type changed (T)."
2023-06-17 03:13:40 +00:00
type_changed_files_count :
description : "Returns the number of `type_changed_files`"
2021-03-05 03:43:17 +00:00
unmerged_files :
2022-10-29 21:48:36 +00:00
description : "Returns only files that are Unmerged (U)."
2023-06-17 03:13:40 +00:00
unmerged_files_count :
description : "Returns the number of `unmerged_files`"
2021-03-05 03:43:17 +00:00
unknown_files :
2022-10-29 21:48:36 +00:00
description : "Returns only files that are Unknown (X)."
2023-06-17 03:13:40 +00:00
unknown_files_count :
description : "Returns the number of `unknown_files`"
2021-09-04 13:42:11 +00:00
all_changed_and_modified_files :
2022-10-29 21:48:36 +00:00
description : "Returns all changed and modified files i.e. *a combination of (ACMRDTUX)*"
2023-06-17 03:13:40 +00:00
all_changed_and_modified_files_count :
description : "Returns the number of `all_changed_and_modified_files`"
2021-12-14 05:21:49 +00:00
all_changed_files :
2022-10-29 21:48:36 +00:00
description : "Returns all changed files i.e. *a combination of all added, copied, modified and renamed files (ACMR)*"
2023-06-17 03:13:40 +00:00
all_changed_files_count :
description : "Returns the number of `all_changed_files`"
2021-05-01 17:32:09 +00:00
any_changed :
2023-06-13 00:07:35 +00:00
description : "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)*."
2021-07-17 19:13:26 +00:00
only_changed :
2023-06-13 00:07:35 +00:00
description : "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)*."
2021-07-17 19:13:26 +00:00
other_changed_files :
2022-10-29 21:48:36 +00:00
description : "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)*."
2023-06-17 03:13:40 +00:00
other_changed_files_count :
description : "Returns the number of `other_changed_files`"
2021-12-14 07:01:31 +00:00
all_modified_files :
2022-10-29 21:48:36 +00:00
description : "Returns all changed files i.e. *a combination of all added, copied, modified, renamed and deleted files (ACMRD)*."
2023-06-17 03:13:40 +00:00
all_modified_files_count :
description : "Returns the number of `all_modified_files`"
2021-12-14 07:01:31 +00:00
any_modified :
2023-06-13 00:07:35 +00:00
description : "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)*."
2021-12-14 07:01:31 +00:00
only_modified :
2023-06-13 00:07:35 +00:00
description : "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs has been modified. (ACMRD)."
2021-12-14 07:01:31 +00:00
other_modified_files :
2022-10-29 21:48:36 +00:00
description : "Returns all other modified files not listed in the files input i.e. *a combination of all added, copied, modified, and deleted files (ACMRD)*"
2023-06-17 03:13:40 +00:00
other_modified_files_count :
description : "Returns the number of `other_modified_files`"
2021-09-05 12:22:47 +00:00
any_deleted :
2023-06-13 00:07:35 +00:00
description : "Returns `true` when any of the filenames provided using the `files*` or `files_ignore*` inputs has been deleted. (D)"
2021-09-05 12:22:47 +00:00
only_deleted :
2023-06-13 00:07:35 +00:00
description : "Returns `true` when only files provided using the `files*` or `files_ignore*` inputs has been deleted. (D)"
2021-09-05 12:22:47 +00:00
other_deleted_files :
2022-10-29 21:48:36 +00:00
description : "Returns all other deleted files not listed in the files input i.e. *a combination of all deleted files (D)*"
2023-06-17 03:13:40 +00:00
other_deleted_files_count :
description : "Returns the number of `other_deleted_files`"
2021-03-05 02:36:52 +00:00
runs :
2023-05-25 18:22:24 +00:00
using : 'node16'
main : 'dist/index.js'
2021-03-05 10:58:42 +00:00
2021-03-05 02:36:52 +00:00
branding :
2021-04-23 10:55:01 +00:00
icon : file-text
2021-03-05 02:36:52 +00:00
color : white