From 2311db86bbe255265ff019a511c52188d0e44b19 Mon Sep 17 00:00:00 2001
From: Paul Hatcherian <1835615+PaulHatch@users.noreply.github.com>
Date: Mon, 5 Oct 2020 18:07:57 -0400
Subject: [PATCH] Add warning regarding checkout v2 behavior

---
 readme.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/readme.md b/readme.md
index 02a781b..72ca7b5 100644
--- a/readme.md
+++ b/readme.md
@@ -77,3 +77,18 @@ job referencing semantic version multiple times. For example:
     change_path: "src/migrations"
     namespace: db
 ```
+
+## Important Note Regarding the Checkout action
+
+Beginning in v2, `actions/checkout` [does not include tags/history by default](https://github.com/actions/checkout/issues/100).
+This history is required to determine the version correctly. To include the history
+and tags, specify the fetch-depth parameter in your checkout action declaration. Specify
+zero to pull the full history and tags.
+
+```
+  - name: Checkout
+    uses: actions/checkout@v2
+    with:
+      fetch-depth: 0
+```
+