diff --git a/README.md b/README.md index 96d246c4e00..cf8b7c12c7d 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ Retrieve all changed files and directories relative to the target branch (`pull_ > * **IMPORTANT:** For `push` events you need to include `fetch-depth: 0` **OR** `fetch-depth: 2` depending on your use case. > * For monorepos where pulling all the branch history might not be desired, you can omit `fetch-depth` for `pull_request` events. > * For files located in a sub-directory ensure that the pattern specified contains `**/` (globstar) to match any preceding directories or explicitly pass the full path relative to the project root. See: [#314](https://github.com/tj-actions/changed-files/issues/314). +> * All multiline inputs should not use double or single qoutes since the value is already a string seperated by a newline character. See [Examples](#examples) for more information. ```yaml name: CI @@ -148,20 +149,20 @@ Support this project with a :star: | include\_all\_old\_new\_renamed\_files | `boolean` | `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). | | old\_new\_separator | `string` | `false` | `','` | Split character for old and new filename pairs | | old\_new\_files\_separator | `string` | `false` | `' '` | Split character for multiple old and new filename pairs | -| files | `string` OR `string[]` | `false` | | Check for changes
using only these
list of file(s)
(Defaults to the
entire repo) | +| files | `string` OR `string[]` | `false` | | Check for changes
using only these
list of file(s)
(Defaults to the
entire repo)
**NOTE:** Multiline file/directory patterns
should not include qoutes.
| | files\_separator | `string` | `false` | `'\n'` | Separator used to split the
`files` input | | files\_from\_source\_file | `string` | `false` | | Source file(s)
used to populate
the `files` input | -| files\_ignore | `string` | `false` | | Ignore changes to these file(s) | +| files\_ignore | `string` | `false` | | Ignore changes to these file(s)
**NOTE:** Multiline file/directory patterns
should not include qoutes.
| | files\_ignore\_separator | `string` | `false` | `'\n'` | Separator used to split the
`files-ignore` input | | files\_ignore\_from\_source\_file | `string` | `false` | | Source file(s)
used to populate
the `files_ignore` input | | sha | `string` | `true` | `${{ github.sha }}` | Specify a different
commit SHA
used for
comparing changes | | base\_sha | `string` | `false` | | Specify a different
base commit SHA
used for
comparing changes | | path | `string` | `false` | `'.'` | Relative path under
`GITHUB_WORKSPACE`
to the repository | -| since\_last\_remote\_commit | `boolean` | `false` | `false` | Use the last commit on the remote
branch as the `base_sha`
(Defaults to the last commit
on the target branch for Pull requests
or the previous commit
on the current branch
for push events).
NOTE: This requires
`fetch-depth: 0`
with `actions/checkout@v3` | -| use\_fork\_point | `boolean` | `false` | `false` | Finds best common ancestor
between two commits
to use in a three-way merge
as the `base_sha`
See: [git merge-base](https://git-scm.com/docs/git-merge-base#Documentation/git-merge-base.txt---fork-point).
NOTE: This pulls the entire commit history of the base branch | +| since\_last\_remote\_commit | `boolean` | `false` | `false` | Use the last commit on the remote
branch as the `base_sha`
(Defaults to the last commit
on the target branch for Pull requests
or the previous commit
on the current branch
for push events).
**NOTE:** This requires
`fetch-depth: 0`
with `actions/checkout@v3` | +| use\_fork\_point | `boolean` | `false` | `false` | Finds best common ancestor
between two commits
to use in a three-way merge
as the `base_sha`
See: [git merge-base](https://git-scm.com/docs/git-merge-base#Documentation/git-merge-base.txt---fork-point).
**NOTE:** This pulls the entire commit history of the base branch | | quotepath | `boolean` | `false` | `true` | Output filenames completely verbatim by setting this to `false` | | diff\_relative | `boolean` | `false` | | Exclude changes outside the current directory and show pathnames relative to it. | -| dir\_names | `boolean` | `false` | `false` | Output unique changed directories instead of filenames.
NOTE: This returns `.` for
changed files located in the root of the project. | +| dir\_names | `boolean` | `false` | `false` | Output unique changed directories instead of filenames.
**NOTE:** This returns `.` for
changed files located in the root of the project. | | json | `boolean` | `false` | `false` | Output changed files in JSON format which can be used for [matrix jobs](https://github.com/tj-actions/changed-files/blob/main/.github/workflows/manual-matrix-test.yml). | | since | `string` | `false` | | Get changed files for commits whose timestamp is older than the given time. | | until | `string` | `false` | | Get changed files for commits whose timestamp is earlier than the given time. |