From 96c5adf0a0e93015e479d8ae9c635d7f9b6bd8b3 Mon Sep 17 00:00:00 2001
From: Tom Eichlersmith <31970302+tomeichlersmith@users.noreply.github.com>
Date: Fri, 27 Sep 2024 13:55:31 -0500
Subject: [PATCH] manually loop over submodules to use describe --tags (#1479)

It looks like git submodule status uses git describe instead of git
describe --tags. I couldn't find any documentation on how to inject
options to git describe so I am just using my own loop over the
submodules in the bash script.
---
 scripts/state | 45 ++++++++++++++-------------------------------
 1 file changed, 14 insertions(+), 31 deletions(-)

diff --git a/scripts/state b/scripts/state
index f65c1837e..eb03bac48 100755
--- a/scripts/state
+++ b/scripts/state
@@ -1,41 +1,24 @@
-#!/bin/sh
+#!/bin/bash
 # scripts/state
 #   display the state of ldmx-sw
 #
 # REQUIREMENTS
-# - awk availabe
+# - sed is available
+# - all submodules have their remove named origin
 # - git has the '-C' flag (>= 1.8.5)
-# - all the submodules have their remotes named 'origin'
 
 set -o errexit
 set -o nounset
 
 git submodule foreach git fetch --tags
-git submodule status | awk '{
-# git submodule status returns lines of the form
-#  <commit> <submodule> (<version>)
-# where <version> is either the tag, branch name, or something else
-# $1 - commit
-# $2 - submodule
-# $3 - version
-# strip the parentheses from the version string
-gsub(/\(|\)/,"",$3);
-# retrieve the URL to the repo
-#  assumes the remote is named "origin" in all the submodules
-git_repo_url="git -C "$2" remote get-url origin";
-git_repo_url | getline repo_url;
-close(git_repo_url);
-# change any SSH remote links back to https
-gsub(/.git$/,"",repo_url);
-gsub(/^git@/,"https://",repo_url);
-gsub(/com:/,"com/",repo_url);
-# if the version matches a version string, link to a release page,
-# otherwise just link to the commit page
-# this is where we use the fact that GitHub links are formulaic
-# across repositories
-if ($3 ~ /^v[0-9]*\.[0-9]*\.[0-9]*$/)
-  printf "- [%s %s](%s/releases/tag/%s)\n", $2, $3, repo_url, $3
-else
-  printf "- [%s %s](%s/commit/%s)\n", $2, substr($1,1,8), repo_url, $1
-}'
-
+for submod in $(git config --file .gitmodules --list | grep path | cut -f 2 -d =); do
+  commit=$(git -C "${submod}" rev-parse HEAD)
+  tag=$(git -C "${submod}" describe --tags)
+  url=$(git -C "${submod}" remote get-url origin | sed 's|\.git$||; s|git\@|https:\/\/|; s|com:|com/|;')
+  if [[ "${tag}" =~ ^v[0-9]*\.[0-9]*\.[0-9]*$ ]]; then
+    url="${url}/releases/tag/${tag}"
+  else
+    url="${url}/commit/${commit}"
+  fi
+  printf -- "- [%s %s](%s)\n" "${submod}" "${tag}" "${url}"
+done