doc: Update README example to checkout tags

redhat-plumbers-in-action · Nov 3, 2022 · 5e9a78c · 5e9a78c
1 parent d44e67d
commit 5e9a78c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -67,13 +67,17 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Development Freezer
         uses: redhat-plumbers-in-action/devel-freezer@latest
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+> **Note**: `fetch-depth: 0` is required in order to have access to full history including tags.
+
 ```yml
 policy:
   - tags: ['alpha', 'beta']