mirror of
https://github.com/tj-actions/changed-files
synced 2024-12-17 13:47:20 +00:00
Updated README.md (#1712)
Co-authored-by: jackton1 <jackton1@users.noreply.github.com>
This commit is contained in:
parent
a36c479373
commit
b082611680
1 changed files with 35 additions and 44 deletions
79
README.md
79
README.md
|
@ -370,7 +370,7 @@ Support this project with a :star:
|
||||||
id: changed-files
|
id: changed-files
|
||||||
with:
|
with:
|
||||||
# Github API URL.
|
# Github API URL.
|
||||||
# Default: ${{ github.api_url }}
|
# Default: `"${{ github.api_url }}"`
|
||||||
api_url: ''
|
api_url: ''
|
||||||
|
|
||||||
# Specify a different base commit SHA or branch used
|
# Specify a different base commit SHA or branch used
|
||||||
|
@ -380,25 +380,25 @@ Support this project with a :star:
|
||||||
# Exclude changes outside the current directory and show path
|
# Exclude changes outside the current directory and show path
|
||||||
# names relative to it. **NOTE:** This requires you to
|
# names relative to it. **NOTE:** This requires you to
|
||||||
# specify the top-level directory via the `path` input.
|
# specify the top-level directory via the `path` input.
|
||||||
# Default: true
|
# Default: `"true"`
|
||||||
diff_relative: ''
|
diff_relative: ''
|
||||||
|
|
||||||
# Output unique changed directories instead of filenames. **NOTE:** This
|
# Output unique changed directories instead of filenames. **NOTE:** This
|
||||||
# returns `.` for changed files located in the current
|
# returns `.` for changed files located in the current
|
||||||
# working directory which defaults to `$GITHUB_WORKSPACE`.
|
# working directory which defaults to `$GITHUB_WORKSPACE`.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
dir_names: ''
|
dir_names: ''
|
||||||
|
|
||||||
# Include only directories that have been deleted as opposed
|
# Include only directories that have been deleted as opposed
|
||||||
# to directory names of files that have been deleted
|
# to directory names of files that have been deleted
|
||||||
# in the `deleted_files` output when `dir_names` is set to
|
# in the `deleted_files` output when `dir_names` is set to
|
||||||
# `true`.
|
# `true`.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
dir_names_deleted_files_include_only_deleted_dirs: ''
|
dir_names_deleted_files_include_only_deleted_dirs: ''
|
||||||
|
|
||||||
# Exclude the current directory represented by `.` from the
|
# Exclude the current directory represented by `.` from the
|
||||||
# output when `dir_names` is set to `true`.
|
# output when `dir_names` is set to `true`.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
dir_names_exclude_current_dir: ''
|
dir_names_exclude_current_dir: ''
|
||||||
|
|
||||||
# File and directory patterns to include in the output
|
# File and directory patterns to include in the output
|
||||||
|
@ -407,8 +407,7 @@ Support this project with a :star:
|
||||||
dir_names_include_files: ''
|
dir_names_include_files: ''
|
||||||
|
|
||||||
# Separator used to split the `dir_names_include_files` input
|
# Separator used to split the `dir_names_include_files` input
|
||||||
# Default:
|
# Default: `"\n"`
|
||||||
|
|
||||||
dir_names_include_files_separator: ''
|
dir_names_include_files_separator: ''
|
||||||
|
|
||||||
# Limit the directory output to a maximum depth e.g
|
# Limit the directory output to a maximum depth e.g
|
||||||
|
@ -416,24 +415,24 @@ Support this project with a :star:
|
||||||
dir_names_max_depth: ''
|
dir_names_max_depth: ''
|
||||||
|
|
||||||
# Escape JSON output.
|
# Escape JSON output.
|
||||||
# Default: true
|
# Default: `"true"`
|
||||||
escape_json: ''
|
escape_json: ''
|
||||||
|
|
||||||
# Fail when the initial diff fails.
|
# Fail when the initial diff fails.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
fail_on_initial_diff_error: ''
|
fail_on_initial_diff_error: ''
|
||||||
|
|
||||||
# Fail when the submodule diff fails.
|
# Fail when the submodule diff fails.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
fail_on_submodule_diff_error: ''
|
fail_on_submodule_diff_error: ''
|
||||||
|
|
||||||
# Fetch additional history for submodules.
|
# Fetch additional history for submodules.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
fetch_additional_submodule_history: ''
|
fetch_additional_submodule_history: ''
|
||||||
|
|
||||||
# Depth of additional branch history fetched. **NOTE**: This can
|
# Depth of additional branch history fetched. **NOTE**: This can
|
||||||
# be adjusted to resolve errors with insufficient history.
|
# be adjusted to resolve errors with insufficient history.
|
||||||
# Default: 50
|
# Default: `"50"`
|
||||||
fetch_depth: ''
|
fetch_depth: ''
|
||||||
|
|
||||||
# File and directory patterns used to detect changes (Defaults to the entire repo if unset)
|
# File and directory patterns used to detect changes (Defaults to the entire repo if unset)
|
||||||
|
@ -444,11 +443,10 @@ Support this project with a :star:
|
||||||
files_from_source_file: ''
|
files_from_source_file: ''
|
||||||
|
|
||||||
# Separator used to split the `files_from_source_file` input
|
# Separator used to split the `files_from_source_file` input
|
||||||
# Default:
|
# Default: `"\n"`
|
||||||
|
|
||||||
files_from_source_file_separator: ''
|
files_from_source_file_separator: ''
|
||||||
|
|
||||||
# Ignore changes to these file(s) **NOTE:** Multiline file/directory patterns
|
# Ignore changes to these file(s) NOTE: Multiline file/directory patterns
|
||||||
# should not include quotes.
|
# should not include quotes.
|
||||||
files_ignore: ''
|
files_ignore: ''
|
||||||
|
|
||||||
|
@ -456,13 +454,11 @@ Support this project with a :star:
|
||||||
files_ignore_from_source_file: ''
|
files_ignore_from_source_file: ''
|
||||||
|
|
||||||
# Separator used to split the `files_ignore_from_source_file` input
|
# Separator used to split the `files_ignore_from_source_file` input
|
||||||
# Default:
|
# Default: `"\n"`
|
||||||
|
|
||||||
files_ignore_from_source_file_separator: ''
|
files_ignore_from_source_file_separator: ''
|
||||||
|
|
||||||
# Separator used to split the `files_ignore` input
|
# Separator used to split the `files_ignore` input
|
||||||
# Default:
|
# Default: `"\n"`
|
||||||
|
|
||||||
files_ignore_separator: ''
|
files_ignore_separator: ''
|
||||||
|
|
||||||
# YAML used to define a set of file patterns
|
# YAML used to define a set of file patterns
|
||||||
|
@ -474,13 +470,11 @@ Support this project with a :star:
|
||||||
files_ignore_yaml_from_source_file: ''
|
files_ignore_yaml_from_source_file: ''
|
||||||
|
|
||||||
# Separator used to split the `files_ignore_yaml_from_source_file` input
|
# Separator used to split the `files_ignore_yaml_from_source_file` input
|
||||||
# Default:
|
# Default: `"\n"`
|
||||||
|
|
||||||
files_ignore_yaml_from_source_file_separator: ''
|
files_ignore_yaml_from_source_file_separator: ''
|
||||||
|
|
||||||
# Separator used to split the `files` input
|
# Separator used to split the `files` input
|
||||||
# Default:
|
# Default: `"\n"`
|
||||||
|
|
||||||
files_separator: ''
|
files_separator: ''
|
||||||
|
|
||||||
# YAML used to define a set of file patterns
|
# YAML used to define a set of file patterns
|
||||||
|
@ -492,54 +486,53 @@ Support this project with a :star:
|
||||||
files_yaml_from_source_file: ''
|
files_yaml_from_source_file: ''
|
||||||
|
|
||||||
# Separator used to split the `files_yaml_from_source_file` input
|
# Separator used to split the `files_yaml_from_source_file` input
|
||||||
# Default:
|
# Default: `"\n"`
|
||||||
|
|
||||||
files_yaml_from_source_file_separator: ''
|
files_yaml_from_source_file_separator: ''
|
||||||
|
|
||||||
# Include `all_old_new_renamed_files` output. Note this can generate a large
|
# Include `all_old_new_renamed_files` output. Note this can generate a large
|
||||||
# output See: #501.
|
# output See: #501.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
include_all_old_new_renamed_files: ''
|
include_all_old_new_renamed_files: ''
|
||||||
|
|
||||||
# Output list of changed files in a JSON formatted
|
# Output list of changed files in a JSON formatted
|
||||||
# string which can be used for matrix jobs. Example:
|
# string which can be used for matrix jobs. Example:
|
||||||
# https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-test.yml
|
# https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-test.yml
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
json: ''
|
json: ''
|
||||||
|
|
||||||
# Apply the negation patterns first. **NOTE:** This affects how
|
# Apply the negation patterns first. **NOTE:** This affects how
|
||||||
# changed files are matched.
|
# changed files are matched.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
negation_patterns_first: ''
|
negation_patterns_first: ''
|
||||||
|
|
||||||
# Split character for old and new renamed filename pairs.
|
# Split character for old and new renamed filename pairs.
|
||||||
# Default:
|
# Default: `" "`
|
||||||
old_new_files_separator: ''
|
old_new_files_separator: ''
|
||||||
|
|
||||||
# Split character for old and new filename pairs.
|
# Split character for old and new filename pairs.
|
||||||
# Default: ,
|
# Default: `","`
|
||||||
old_new_separator: ''
|
old_new_separator: ''
|
||||||
|
|
||||||
# Directory to store output files.
|
# Directory to store output files.
|
||||||
# Default: .github/outputs
|
# Default: `".github/outputs"`
|
||||||
output_dir: ''
|
output_dir: ''
|
||||||
|
|
||||||
# Output renamed files as deleted and added files.
|
# Output renamed files as deleted and added files.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
output_renamed_files_as_deleted_and_added: ''
|
output_renamed_files_as_deleted_and_added: ''
|
||||||
|
|
||||||
# Specify a relative path under `$GITHUB_WORKSPACE` to locate the
|
# Specify a relative path under `$GITHUB_WORKSPACE` to locate the
|
||||||
# repository.
|
# repository.
|
||||||
# Default: .
|
# Default: `"."`
|
||||||
path: ''
|
path: ''
|
||||||
|
|
||||||
# Use non ASCII characters to match files and output
|
# Use non ASCII characters to match files and output
|
||||||
# the filenames completely verbatim by setting this to `false`
|
# the filenames completely verbatim by setting this to `false`
|
||||||
# Default: true
|
# Default: `"true"`
|
||||||
quotepath: ''
|
quotepath: ''
|
||||||
|
|
||||||
# Recover deleted files.
|
# Recover deleted files.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
recover_deleted_files: ''
|
recover_deleted_files: ''
|
||||||
|
|
||||||
# Recover deleted files to a new destination directory, defaults
|
# Recover deleted files to a new destination directory, defaults
|
||||||
|
@ -557,17 +550,15 @@ Support this project with a :star:
|
||||||
recover_files_ignore: ''
|
recover_files_ignore: ''
|
||||||
|
|
||||||
# Separator used to split the `recover_files_ignore` input
|
# Separator used to split the `recover_files_ignore` input
|
||||||
# Default:
|
# Default: `"\n"`
|
||||||
|
|
||||||
recover_files_ignore_separator: ''
|
recover_files_ignore_separator: ''
|
||||||
|
|
||||||
# Separator used to split the `recover_files` input
|
# Separator used to split the `recover_files` input
|
||||||
# Default:
|
# Default: `"\n"`
|
||||||
|
|
||||||
recover_files_separator: ''
|
recover_files_separator: ''
|
||||||
|
|
||||||
# Split character for output strings
|
# Split character for output strings
|
||||||
# Default:
|
# Default: `" "`
|
||||||
separator: ''
|
separator: ''
|
||||||
|
|
||||||
# Specify a different commit SHA or branch used for
|
# Specify a different commit SHA or branch used for
|
||||||
|
@ -583,19 +574,19 @@ Support this project with a :star:
|
||||||
# the target branch for pull request events and the
|
# the target branch for pull request events and the
|
||||||
# previous remote commit of the current branch for push
|
# previous remote commit of the current branch for push
|
||||||
# events.
|
# events.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
since_last_remote_commit: ''
|
since_last_remote_commit: ''
|
||||||
|
|
||||||
# Skip the initial fetch to improve performance for shallow
|
# Skip the initial fetch to improve performance for shallow
|
||||||
# repositories. NOTE: This could lead to errors with missing
|
# repositories. NOTE: This could lead to errors with missing
|
||||||
# history and the intended use is limited to when
|
# history and the intended use is limited to when
|
||||||
# you've fetched the history necessary to perform the diff.
|
# you've fetched the history necessary to perform the diff.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
skip_initial_fetch: ''
|
skip_initial_fetch: ''
|
||||||
|
|
||||||
# GitHub token used to fetch changed files from Github's
|
# GitHub token used to fetch changed files from Github's
|
||||||
# API.
|
# API.
|
||||||
# Default: ${{ github.token }}
|
# Default: `"${{ github.token }}"`
|
||||||
token: ''
|
token: ''
|
||||||
|
|
||||||
# Get changed files for commits whose timestamp is earlier
|
# Get changed files for commits whose timestamp is earlier
|
||||||
|
@ -605,7 +596,7 @@ Support this project with a :star:
|
||||||
# Write outputs to the `output_dir` defaults to `.github/outputs` folder.
|
# Write outputs to the `output_dir` defaults to `.github/outputs` folder.
|
||||||
# **NOTE:** This creates a `.txt` file by default and
|
# **NOTE:** This creates a `.txt` file by default and
|
||||||
# a `.json` file if `json` is set to `true`.
|
# a `.json` file if `json` is set to `true`.
|
||||||
# Default: false
|
# Default: `"false"`
|
||||||
write_output_files: ''
|
write_output_files: ''
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in a new issue