Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md #1714

Merged
merged 1 commit into from
Nov 16, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
72 changes: 36 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ Support this project with a :star:
id: changed-files
with:
# Github API URL.
# Default: `"${{ github.api_url }}"`
# Default: "${{ github.api_url }}"
api_url: ''

# Specify a different base commit SHA or branch used
Expand All @@ -380,25 +380,25 @@ Support this project with a :star:
# 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.
# Default: `"true"`
# Default: "true"
diff_relative: ''

# Output unique changed directories instead of filenames. NOTE: This
# returns `.` for changed files located in the current
# working directory which defaults to `$GITHUB_WORKSPACE`.
# Default: `"false"`
# Default: "false"
dir_names: ''

# 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`.
# Default: `"false"`
# Default: "false"
dir_names_deleted_files_include_only_deleted_dirs: ''

# Exclude the current directory represented by `.` from the
# output when `dir_names` is set to `true`.
# Default: `"false"`
# Default: "false"
dir_names_exclude_current_dir: ''

# File and directory patterns to include in the output
Expand All @@ -407,58 +407,58 @@ Support this project with a :star:
dir_names_include_files: ''

# Separator used to split the `dir_names_include_files` input
# Default: `"\n"`
# Default: "\n"
dir_names_include_files_separator: ''

# Limit the directory output to a maximum depth e.g
# `test/test1/test2` with max depth of `2` returns `test/test1`.
dir_names_max_depth: ''

# Escape JSON output.
# Default: `"true"`
# Default: "true"
escape_json: ''

# Fail when the initial diff fails.
# Default: `"false"`
# Default: "false"
fail_on_initial_diff_error: ''

# Fail when the submodule diff fails.
# Default: `"false"`
# Default: "false"
fail_on_submodule_diff_error: ''

# Fetch additional history for submodules.
# Default: `"false"`
# Default: "false"
fetch_additional_submodule_history: ''

# Depth of additional branch history fetched. NOTE: This can
# be adjusted to resolve errors with insufficient history.
# Default: `"50"`
# Default: "50"
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).
# NOTE: Multiline file/directory patterns should not include quotes.
files: ''

# Source file(s) used to populate the `files` input.
files_from_source_file: ''

# Separator used to split the `files_from_source_file` input
# Default: `"\n"`
# Default: "\n"
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.
files_ignore: ''

# Source file(s) used to populate the `files_ignore` input
files_ignore_from_source_file: ''

# Separator used to split the `files_ignore_from_source_file` input
# Default: `"\n"`
# Default: "\n"
files_ignore_from_source_file_separator: ''

# Separator used to split the `files_ignore` input
# Default: `"\n"`
# Default: "\n"
files_ignore_separator: ''

# YAML used to define a set of file patterns
Expand All @@ -470,11 +470,11 @@ Support this project with a :star:
files_ignore_yaml_from_source_file: ''

# Separator used to split the `files_ignore_yaml_from_source_file` input
# Default: `"\n"`
# Default: "\n"
files_ignore_yaml_from_source_file_separator: ''

# Separator used to split the `files` input
# Default: `"\n"`
# Default: "\n"
files_separator: ''

# YAML used to define a set of file patterns
Expand All @@ -486,53 +486,53 @@ Support this project with a :star:
files_yaml_from_source_file: ''

# Separator used to split the `files_yaml_from_source_file` input
# Default: `"\n"`
# Default: "\n"
files_yaml_from_source_file_separator: ''

# Include `all_old_new_renamed_files` output. Note this can generate a large
# output See: #501.
# Default: `"false"`
# Default: "false"
include_all_old_new_renamed_files: ''

# 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
# Default: `"false"`
# Default: "false"
json: ''

# Apply the negation patterns first. NOTE: This affects how
# changed files are matched.
# Default: `"false"`
# Default: "false"
negation_patterns_first: ''

# Split character for old and new renamed filename pairs.
# Default: `" "`
# Default: " "
old_new_files_separator: ''

# Split character for old and new filename pairs.
# Default: `","`
# Default: ","
old_new_separator: ''

# Directory to store output files.
# Default: `".github/outputs"`
# Default: ".github/outputs"
output_dir: ''

# Output renamed files as deleted and added files.
# Default: `"false"`
# Default: "false"
output_renamed_files_as_deleted_and_added: ''

# Specify a relative path under `$GITHUB_WORKSPACE` to locate the
# repository.
# Default: `"."`
# Default: "."
path: ''

# Use non-ASCII characters to match files and output the
# filenames completely verbatim by setting this to `false`
# Default: `"true"`
# Default: "true"
quotepath: ''

# Recover deleted files.
# Default: `"false"`
# Default: "false"
recover_deleted_files: ''

# Recover deleted files to a new destination directory, defaults
Expand All @@ -550,15 +550,15 @@ Support this project with a :star:
recover_files_ignore: ''

# Separator used to split the `recover_files_ignore` input
# Default: `"\n"`
# Default: "\n"
recover_files_ignore_separator: ''

# Separator used to split the `recover_files` input
# Default: `"\n"`
# Default: "\n"
recover_files_separator: ''

# Split character for output strings
# Default: `" "`
# Default: " "
separator: ''

# Specify a different commit SHA or branch used for
Expand All @@ -574,19 +574,19 @@ Support this project with a :star:
# the target branch for pull request events and the
# previous remote commit of the current branch for push
# events.
# Default: `"false"`
# Default: "false"
since_last_remote_commit: ''

# 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.
# Default: `"false"`
# Default: "false"
skip_initial_fetch: ''

# GitHub token used to fetch changed files from Github's
# API.
# Default: `"${{ github.token }}"`
# Default: "${{ github.token }}"
token: ''

# Get changed files for commits whose timestamp is earlier
Expand All @@ -596,7 +596,7 @@ Support this project with a :star:
# 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`.
# Default: `"false"`
# Default: "false"
write_output_files: ''

```
Expand Down