Skip to content

Commit

Permalink
Updated README.md (#1755)
Browse files Browse the repository at this point in the history
Co-authored-by: jackton1 <jackton1@users.noreply.github.com>
  • Loading branch information
tj-actions-bot and jackton1 committed Nov 28, 2023
1 parent 5c74583 commit 48427af
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

Effortlessly track all changed files and directories relative to a target branch, preceding commit or the last remote commit returning **relative paths** from the project root using this GitHub action.

> [!NOTE]
> \[!NOTE]
>
> * This action solely identifies files that have undergone changes within the context of events such as `pull_request*`, `push`, and more. However, it doesn't detect pending uncommitted changes created during the workflow execution.
>
Expand Down Expand Up @@ -83,7 +83,7 @@ And many more...

## Usage 💻

> [!IMPORTANT]
> \[!IMPORTANT]
>
> * **Push Events**: When configuring [`actions/checkout`](https://github.com/actions/checkout#usage), make sure to set [`fetch-depth`](https://github.com/actions/checkout#usage) to either `0` or `2`, depending on your use case.
> * **Mono Repositories**: To avoid pulling the entire branch history, you can utilize the default [`actions/checkout`](https://github.com/actions/checkout#usage)'s [`fetch-depth`](https://github.com/actions/checkout#usage) of `1` for [`pull_request`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request) events.
Expand Down Expand Up @@ -296,7 +296,7 @@ Support this project with a :star:

[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png

> [!WARNING]
> \[!WARNING]
>
> * When using `files_yaml*` inputs ensure all outputs are prefixed by the key `test_{...}` e.g. `test_added_files`, `test_any_changed`
> * All keys must start with a letter or \_ and contain only alphanumeric characters, -, or \_.
Expand Down Expand Up @@ -1217,7 +1217,7 @@ And many more...

## Important Notice ⚠️

> [!IMPORTANT]
> \[!IMPORTANT]
>
> * Spaces in file names can introduce bugs when using bash loops. See: [#216](https://github.com/tj-actions/changed-files/issues/216)
> However, this action will handle spaces in file names, with a recommendation of using a separator to prevent any hidden issues.
Expand Down

0 comments on commit 48427af

Please sign in to comment.