Merge pull request #199 from tegonal/improve/latestRemoteTag-docu

document how the tag filter of latestRemoteTag could be used
tegonal · Oct 16, 2024 · ec5003e · ec5003e
2 parents a0760fa + 9a80699
commit ec5003e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1444,6 +1444,8 @@ latestTag=$(latestRemoteTag)
 echo "latest tag on origin: $latestTag"
 latestTag=$(latestRemoteTag upstream)
 echo "latest tag on upstream: $latestTag"
+latestTag=$(latestRemoteTag origin "^v1\.[0-9]+\.[0-9]+$")
+echo "latest tag in the major 1.x.x series on origin without release candidates: $latestTag"
 ```
 
 </utility-git-utils>

diff --git a/src/utility/git-utils.doc.sh b/src/utility/git-utils.doc.sh
@@ -45,3 +45,5 @@ latestTag=$(latestRemoteTag)
 echo "latest tag on origin: $latestTag"
 latestTag=$(latestRemoteTag upstream)
 echo "latest tag on upstream: $latestTag"
+latestTag=$(latestRemoteTag origin "^v1\.[0-9]+\.[0-9]+$")
+echo "latest tag in the major 1.x.x series on origin without release candidates: $latestTag"
diff --git a/src/utility/git-utils.sh b/src/utility/git-utils.sh
@@ -60,6 +60,8 @@
 #    echo "latest tag on origin: $latestTag"
 #    latestTag=$(latestRemoteTag upstream)
 #    echo "latest tag on upstream: $latestTag"
+#    latestTag=$(latestRemoteTag origin "^v1\.[0-9]+\.[0-9]+$")
+#    echo "latest tag in the major 1.x.x series on origin without release candidates: $latestTag"
 #
 ###################################
 set -euo pipefail