From bdd5f94ce0880d7c5bec77a9675a2126c9cdb6f5 Mon Sep 17 00:00:00 2001
From: Philippe Coval <philippe.coval@silabs.com>
Date: Thu, 13 Feb 2025 21:40:01 +0100
Subject: [PATCH] README: Add hint when using annotated tags
Until a proper fix is released,
I believe this will be helpful to to share this trick to community.
Bug: https://github.com/actions/checkout/issues/290
Relate-to: https://github.com/actions/checkout/pull/1506
Relate-to: https://github.com/actions/checkout/issues/649
Origin: https://github.com/actions/checkout/pulls?q=author%3Arzr
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
---
README.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/README.md b/README.md
index 64dc02581..f1e214965 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
# The branch, tag or SHA to checkout. When checking out the repository that
# triggered a workflow, this defaults to the reference or SHA for that event.
+ # For tags, it can be forced to ${{ github.ref }} (useful if using git-describe)
# Otherwise, uses the default branch.
ref: ''