From de8c78648f5b57bb261038a5882d261349b505d0 Mon Sep 17 00:00:00 2001
From: Mike Penz <mikepenz@gmail.com>
Date: Wed, 7 Apr 2021 10:14:18 +0200
Subject: [PATCH] - add note on required `checkout` step, to use configurations

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index eb299d0..8e19164 100644
--- a/README.md
+++ b/README.md
@@ -134,6 +134,8 @@ The action supports flexible configuration options to modify vast areas of its b
     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+⚠️ Please note: It is required to have a `checkout` step prior to the changelog step, to allow the action to discover the configuration file.
+
 ⚠️ When running this action for a non tags trigger the `toTag` can't be automatically resolved, as such it is either required to provide `toTag` directly, or to specify a different `fetch-depth:` with the checkout action to include tags.
 
 💡 By default not specifying `fromTag` or `toTag` will resolve `toTag` from either the `ref` or alternatively fallback to the latest tag from git. `fromTag` is resolved by sorting tags using [semver](https://semver.org/). Check the [configuration](#configuration-specification) for alternatives.