Merge branch 'feature/git-ref' of github.com:jonpugh/goatscripts into feature/git-ref

Author: jonpugh

.github/workflows/scripts.tests.yml

@@ -75,8 +75,9 @@ jobs:
     - name: get current reference
       run: |
         git-ref
+        git-ref --type
         REF=$(git-ref)
-        echo "Current ref: $REF" >> $GITHUB_STEP_SUMMARY
+        echo "Current ref: $REF $TYPE" >> $GITHUB_STEP_SUMMARY
         if [[ "$REF" != "${{ github.sha }}" ]]; then 
           echo "Output of git-ref script ($REF) does not match github.sha (${{ github.sha }})"
           exit 1; 

README.md

@@ -20,6 +20,7 @@ jobs:
 ## Scripts
 - `run-with-summary`: Runs a command and generates a markdown summary with output and execution details.
 - `wait-for`: Runs a command repeatedly until it passes.
+- `git-ref`: Prints the branch or tag name of a git clone.
 
 ## Run With Summary
 
@@ -96,6 +97,23 @@ wait-for curl https://deploy-url/ready
 # SILENT: Set to 1 to not print any output except the timeout exceeded error. Useful when running from other scripts. See wait-mysql
 ```
 
+## `git-ref`
+
+> Print the branch or tag name of the current directory of a cloned git repo. Use `--type` to show if it is a branch or tag.
+
+```
+git-ref [OPTIONS]
+
+Prints the branch or tag of the current git repository.
+
+Options:
+
+  -t, --type    Print the git reference type ('branch' or 'tag').
+
+    If PWD is tracking a branch, print "branch".
+    If PWD is in a DETACHED HEAD state, and there is a tag for the SHA, print "tag".
+    If the PWD is in a DETACHED HEAD state, and there is no tag, exit with an error.
+```
 
 ## History