3
0
Fork 0
mirror of https://github.com/tj-actions/changed-files synced 2024-12-16 09:27:57 +00:00

Updated README.md (#2068)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
This commit is contained in:
tj-actions[bot] 2024-04-27 04:01:05 -06:00 committed by GitHub
parent 7d02310f6e
commit 0c82494d63
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

261
README.md
View file

@ -335,52 +335,68 @@ Support this project with a :star:
# 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
# for comparing changes # SHA or branch used for
# comparing changes
# Type: string # Type: string
base_sha: '' base_sha: ''
# Exclude changes outside the current directory and show path # Exclude changes outside the current
# names relative to it. NOTE: This requires you to # directory and show path names
# specify the top-level directory via the `path` input. # relative to it. NOTE: This
# requires you to specify the
# top-level directory via the `path`
# input.
# Type: boolean # Type: boolean
# Default: "true" # Default: "true"
diff_relative: '' diff_relative: ''
# Output unique changed directories instead of filenames. NOTE: This # Output unique changed directories instead
# returns `.` for changed files located in the current # of filenames. NOTE: This returns
# working directory which defaults to `$GITHUB_WORKSPACE`. # `.` for changed files located
# in the current working directory
# which defaults to `$GITHUB_WORKSPACE`.
# Type: boolean # Type: boolean
# Default: "false" # Default: "false"
dir_names: '' dir_names: ''
# Include only directories that have been deleted as opposed # Include only directories that have
# to directory names of files that have been deleted # been deleted as opposed to
# in the `deleted_files` output when `dir_names` is set to # directory names of files that
# `true`. # have been deleted in the
# `deleted_files` output when `dir_names` is
# set to `true`.
# Type: boolean # Type: boolean
# 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
# output when `dir_names` is set to `true`. # by `.` from the output
# when `dir_names` is set to
# `true`.
# Type: boolean # Type: boolean
# 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
# when `dir_names` is set to `true`. NOTE: This returns # include in the output when
# only the matching files and also the directory names. # `dir_names` is set to `true`.
# NOTE: This returns only the
# matching files and also the
# directory names.
# Type: string # Type: string
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
# Type: string # Type: string
# Default: "\n" # 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
# `test/test1/test2` with max depth of `2` returns `test/test1`. # a maximum depth e.g `test/test1/test2`
# with max depth of `2`
# returns `test/test1`.
# Type: string # Type: string
dir_names_max_depth: '' dir_names_max_depth: ''
@ -394,12 +410,14 @@ Support this project with a :star:
# Default: "false" # Default: "false"
exclude_submodules: '' exclude_submodules: ''
# Fail when the initial diff fails. # Fail when the initial diff
# fails.
# Type: boolean # Type: boolean
# 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.
# Type: boolean # Type: boolean
# Default: "false" # Default: "false"
fail_on_submodule_diff_error: '' fail_on_submodule_diff_error: ''
@ -409,117 +427,140 @@ Support this project with a :star:
# 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
# be adjusted to resolve errors with insufficient history. # fetched. NOTE: This can be
# adjusted to resolve errors with
# insufficient history.
# Type: string # Type: string
# Default: "25" # Default: "25"
fetch_depth: '' fetch_depth: ''
# Maximum number of retries to fetch missing history. # Maximum number of retries to
# fetch missing history.
# Type: string # Type: string
# Default: "20" # Default: "20"
fetch_missing_history_max_retries: '' fetch_missing_history_max_retries: ''
# File and directory patterns used to detect changes (Defaults to the entire repo if unset). # File and directory patterns used
# NOTE: Multiline file/directory patterns should not include quotes. # to detect changes (Defaults to the entire repo if unset). NOTE:
# Multiline file/directory patterns should not
# include quotes.
# Type: string # Type: string
files: '' files: ''
# Source file(s) used to populate the `files` input. # Source file(s) used to populate
# the `files` input.
# Type: string # Type: string
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.
# Type: string # Type: string
# Default: "\n" # 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).
# should not include quotes. # NOTE: Multiline file/directory patterns should
# not include quotes.
# Type: string # Type: string
files_ignore: '' files_ignore: ''
# Source file(s) used to populate the `files_ignore` input # Source file(s) used to populate
# the `files_ignore` input
# Type: string # Type: string
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
# Type: string # Type: string
# Default: "\n" # 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
# Type: string # Type: string
# Default: "\n" # Default: "\n"
files_ignore_separator: '' files_ignore_separator: ''
# YAML used to define a set of file patterns # YAML used to define a
# to ignore changes # set of file patterns to
# ignore changes
# Type: string # Type: string
files_ignore_yaml: '' files_ignore_yaml: ''
# Source file(s) used to populate the `files_ignore_yaml` input. Example: # Source file(s) used to populate
# https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml # the `files_ignore_yaml` input. Example: https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml
# Type: string # Type: string
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
# Type: string # Type: string
# Default: "\n" # 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
# Type: string # Type: string
# Default: "\n" # Default: "\n"
files_separator: '' files_separator: ''
# YAML used to define a set of file patterns # YAML used to define a
# to detect changes # set of file patterns to
# detect changes
# Type: string # Type: string
files_yaml: '' files_yaml: ''
# Source file(s) used to populate the `files_yaml` input. Example: # Source file(s) used to populate
# https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml # the `files_yaml` input. Example: https://github.com/tj-actions/changed-files/blob/main/test/changed-files.yml
# Type: string # Type: string
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
# Type: string # Type: string
# Default: "\n" # 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
# output See: #501. # can generate a large output
# See: #501.
# Type: boolean # Type: boolean
# 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
# string which can be used for matrix jobs. Example: # in a JSON formatted string
# https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-example.yml # which can be used for
# matrix jobs. Example: https://github.com/tj-actions/changed-files/blob/main/.github/workflows/matrix-example.yml
# Type: boolean # Type: boolean
# Default: "false" # Default: "false"
json: '' json: ''
# Output changed files in a format that can be # Output changed files in a
# used for matrix jobs. Alias for setting inputs `json` # format that can be used
# to `true` and `escape_json` to `false`. # for matrix jobs. Alias for
# setting inputs `json` to `true`
# and `escape_json` to `false`.
# Type: boolean # Type: boolean
# Default: "false" # Default: "false"
matrix: '' matrix: ''
# Apply the negation patterns first. NOTE: This affects how # Apply the negation patterns first.
# changed files are matched. # NOTE: This affects how changed
# files are matched.
# Type: boolean # Type: boolean
# 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.
# Type: string # Type: string
# 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.
# Type: string # Type: string
# Default: "," # Default: ","
old_new_separator: '' old_new_separator: ''
@ -529,19 +570,22 @@ Support this project with a :star:
# 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.
# Type: boolean # Type: boolean
# 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
# repository. # `$GITHUB_WORKSPACE` to locate the repository.
# Type: string # Type: string
# Default: "." # Default: "."
path: '' path: ''
# Use non-ASCII characters to match files and output the # Use non-ASCII characters to match
# filenames completely verbatim by setting this to `false` # files and output the filenames
# completely verbatim by setting this
# to `false`
# Type: boolean # Type: boolean
# Default: "true" # Default: "true"
quotepath: '' quotepath: ''
@ -551,35 +595,41 @@ Support this project with a :star:
# Default: "false" # Default: "false"
recover_deleted_files: '' recover_deleted_files: ''
# Recover deleted files to a new destination directory, defaults # Recover deleted files to a
# to the original location. # new destination directory, defaults to
# the original location.
# Type: string # Type: string
recover_deleted_files_to_destination: '' recover_deleted_files_to_destination: ''
# File and directory patterns used to recover deleted files, # File and directory patterns used
# defaults to the patterns provided via the `files`, `files_from_source_file`, # to recover deleted files, defaults
# `files_ignore` and `files_ignore_from_source_file` inputs or all deleted files if # to the patterns provided via
# no patterns are provided. # the `files`, `files_from_source_file`, `files_ignore` and
# `files_ignore_from_source_file` inputs or all deleted
# files if no patterns are
# provided.
# Type: string # Type: string
recover_files: '' recover_files: ''
# File and directory patterns to ignore when recovering deleted # File and directory patterns to
# files. # ignore when recovering deleted files.
# Type: string # Type: string
recover_files_ignore: '' recover_files_ignore: ''
# Separator used to split the `recover_files_ignore` input # Separator used to split the
# `recover_files_ignore` input
# Type: string # Type: string
# Default: "\n" # 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
# Type: string # Type: string
# Default: "\n" # Default: "\n"
recover_files_separator: '' recover_files_separator: ''
# Apply sanitization to output filenames before being set as # Apply sanitization to output filenames
# output. # before being set as output.
# Type: boolean # Type: boolean
# Default: "true" # Default: "true"
safe_output: '' safe_output: ''
@ -589,59 +639,74 @@ Support this project with a :star:
# Default: " " # Default: " "
separator: '' separator: ''
# Specify a different commit SHA or branch used for # Specify a different commit SHA
# comparing changes # or branch used for comparing
# changes
# Type: string # Type: string
sha: '' sha: ''
# Get changed files for commits whose timestamp is older # Get changed files for commits
# than the given time. # whose timestamp is older than
# the given time.
# Type: string # Type: string
since: '' since: ''
# Use the last commit on the remote branch as # Use the last commit on
# the `base_sha`. Defaults to the last non-merge commit on # the remote branch as the
# the target branch for pull request events and the # `base_sha`. Defaults to the last
# previous remote commit of the current branch for push # non-merge commit on the target
# events. # branch for pull request events
# and the previous remote commit
# of the current branch for
# push events.
# Type: boolean # Type: boolean
# Default: "false" # Default: "false"
since_last_remote_commit: '' since_last_remote_commit: ''
# Skip initially fetching additional history to improve performance for # Skip initially fetching additional history
# shallow repositories. NOTE: This could lead to errors with # to improve performance for shallow
# missing history. It's intended to be used when you've # repositories. NOTE: This could lead
# fetched all necessary history to perform the diff. # to errors with missing history.
# It's intended to be used
# when you've fetched all necessary
# history to perform the diff.
# Type: boolean # Type: boolean
# 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
# API. # changed files from Github's API.
# Type: string # Type: string
# Default: "${{ github.token }}" # Default: "${{ github.token }}"
token: '' token: ''
# Get changed files for commits whose timestamp is earlier # Get changed files for commits
# than the given time. # whose timestamp is earlier than
# the given time.
# Type: string # Type: string
until: '' until: ''
# Use POSIX path separator `/` for output file paths # Use POSIX path separator `/`
# on Windows. # for output file paths on
# Windows.
# Type: boolean # Type: boolean
# Default: "false" # Default: "false"
use_posix_path_separator: '' use_posix_path_separator: ''
# Force the use of Github's REST API even when # Force the use of Github's
# a local copy of the repository exists # REST API even when a
# local copy of the repository
# exists
# Type: boolean # Type: boolean
# Default: "false" # Default: "false"
use_rest_api: '' use_rest_api: ''
# Write outputs to the `output_dir` defaults to `.github/outputs` folder. # Write outputs to the `output_dir`
# NOTE: This creates a `.txt` file by default and # defaults to `.github/outputs` folder. NOTE:
# a `.json` file if `json` is set to `true`. # This creates a `.txt` file
# by default and a `.json`
# file if `json` is set
# to `true`.
# Type: boolean # Type: boolean
# Default: "false" # Default: "false"
write_output_files: '' write_output_files: ''