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

chore: Update README.md #1087

Merged
merged 1 commit into from Apr 14, 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
8 changes: 4 additions & 4 deletions README.md
Expand Up @@ -63,7 +63,7 @@ Retrieve all changed files and directories relative to a target branch, preceedi

## Usage

> NOTE: :warning:
> **Warning**:
>
> * **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.
Expand Down Expand Up @@ -664,7 +664,7 @@ See [inputs](#inputs) for more information.
</li>
</ul>

> NOTE: This setting overrides the commit sha used by setting `since_last_remote_commit` to true.
> **Warning**: This setting overrides the commit sha used by setting `since_last_remote_commit` to true.
> It is recommended to use either solution that works for your use case.

See [inputs](#inputs) for more information.
Expand Down Expand Up @@ -744,7 +744,7 @@ And many more...

## Known Limitation

> NOTE: :warning:
> **Warning**:
>
> * Using characters like `\n`, `%`, `.` and `\r` as separators would be [URL encoded](https://www.w3schools.com/tags/ref_urlencode.asp)
> * Spaces in file names can introduce bugs when using bash loops. See: [#216](https://github.com/tj-actions/changed-files/issues/216)
Expand Down Expand Up @@ -775,7 +775,7 @@ With the switch from using grep's Extended regex to match files to the natively

## Credits

This package was created with [Cookiecutter](https://github.com/cookiecutter/cookiecutter).
This package was created with [cookiecutter-action](https://github.com/tj-actions/cookiecutter-action).

* [tj-actions/glob](https://github.com/tj-actions/glob)
* [tj-actions/auto-doc](https://github.com/tj-actions/auto-doc)
Expand Down