From 742ed362b6c6415493f2dd3a2e86ccbb60e1035a Mon Sep 17 00:00:00 2001 From: Tonye Jack Date: Tue, 28 Nov 2023 09:58:20 -0700 Subject: [PATCH] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f2789029..590624ec 100644 --- a/README.md +++ b/README.md @@ -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** :exclamation: +> [!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. > @@ -83,7 +83,7 @@ And many more... ## Usage 💻 -> **Important** :bangbang: +> [!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. @@ -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 \_. @@ -1217,7 +1217,7 @@ And many more... ## Important Notice ⚠️ -> **Important** :bangbang: +> [!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.