fixup! chore: make dependency checks nicer

coder · deansheather · Jun 18, 2022 · Jun 7, 2022 · Jun 8, 2022 · Jun 8, 2022
commit c5245072394b5f8e3eea9728ec31ce0d7215000b
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -13,7 +13,7 @@ on:
   workflow_dispatch:
     inputs:
       snapshot:
-        description: Allow a +dev version to be generated, implies dry_run.
+        description: Force a dev version to be generated, implies dry_run.
         type: boolean
         required: true
       dry_run:
@@ -24,6 +24,7 @@ on:
 # In a non-snapshot we want the ./scripts/version.sh script to never generate a
 # +dev version.
 env:
+  CODER_FORCE_DEV_VERSION: ${{ github.event.inputs.snapshot && 'true' || 'false' }}
   CODER_NO_DEV_VERSION: ${{ github.event.inputs.snapshot && 'false' || 'true' }}
 
 jobs:

diff --git a/scripts/build_go.sh b/scripts/build_go.sh
@@ -2,7 +2,7 @@
 
 # This script builds a single Go binary of Coder with the given parameters.
 #
-# Usage: ./build_go.sh [--version 1.2.3+devel.abcdef] [--os linux] [--arch amd64] [--output path/to/output] [--slim]
+# Usage: ./build_go.sh [--version 1.2.3-devel+abcdef] [--os linux] [--arch amd64] [--output path/to/output] [--slim]
 #
 # Defaults to linux:amd64 with slim disabled, but can be controlled with GOOS,
 # GOARCH and CODER_SLIM_BUILD=1. If no version is specified, defaults to the

diff --git a/scripts/build_go_matrix.sh b/scripts/build_go_matrix.sh
@@ -3,7 +3,7 @@
 # This script builds multiple Go binaries for Coder with the given OS and
 # architecture combinations.
 #
-# Usage: ./build_go_matrix.sh [--version 1.2.3+devel.abcdef] [--output dist/] [--slim] [--sign-darwin] [--archive] [--package-linux] os1:arch1,arch2 os2:arch1 os1:arch3
+# Usage: ./build_go_matrix.sh [--version 1.2.3-devel+abcdef] [--output dist/] [--slim] [--sign-darwin] [--archive] [--package-linux] os1:arch1,arch2 os2:arch1 os1:arch3
 #
 # If no OS:arch combinations are provided, nothing will happen and no error will
 # be returned. Slim builds are disabled by default. If no version is specified,

diff --git a/scripts/build_go_slim.sh b/scripts/build_go_slim.sh
@@ -3,7 +3,7 @@
 # This script builds multiple "slim" Go binaries for Coder with the given OS and
 # architecture combinations. This wraps ./build_go_matrix.sh.
 #
-# Usage: ./build_go_slim.sh [--version 1.2.3+devel.abcdef] [--output dist/] os1:arch1,arch2 os2:arch1 os1:arch3
+# Usage: ./build_go_slim.sh [--version 1.2.3-devel+abcdef] [--output dist/] os1:arch1,arch2 os2:arch1 os1:arch3
 #
 # If no OS:arch combinations are provided, nothing will happen and no error will
 # be returned. If no version is specified, defaults to the version from

diff --git a/scripts/image_tag.sh b/scripts/image_tag.sh
@@ -54,5 +54,6 @@ if [[ "$arch" != "" ]]; then
 	tag+="-$arch"
 fi
 
+# Dev versions contain plus signs which are illegal characters in Docker tags.
 tag="${tag//+/-}"
 echo "$image:$tag"
diff --git a/scripts/version.sh b/scripts/version.sh
@@ -3,6 +3,12 @@
 # This script generates the version string used by Coder, including for dev
 # versions. Note: the version returned by this script will NOT include the "v"
 # prefix that is included in the Git tag.
+#
+# If $CODER_FORCE_DEV_VERSION is set to "true", the returned version will be a
+# dev version even if the current commit is tagged.
+#
+# If $CODER_NO_DEV_VERSION is set to "true", the script will fail if the current
+# commit is not tagged.
 
 set -euo pipefail
 # shellcheck source=scripts/lib.sh
@@ -17,9 +23,9 @@ version="$last_tag"
 
 # If the HEAD has extra commits since the last tag then we are in a dev version.
 #
-# Dev versions are denoted by the "+dev." suffix with a trailing commit short
+# Dev versions are denoted by the "-devel+" suffix with a trailing commit short
 # SHA.
-if [[ "$last_tag" != "$current" ]]; then
+if [[ "${CODER_FORCE_DEV_VERSION:-}" == *t* ]] || [[ "$last_tag" != "$current" ]]; then
 	if [[ "${CODER_NO_DEV_VERSION:-}" == *t* ]]; then
 		# make won't exit on $(shell cmd) failures :(
 		if [[ "$(ps -o comm= "$PPID" || true)" == *make* ]]; then
@@ -30,7 +36,7 @@ if [[ "$last_tag" != "$current" ]]; then
 
 		error "version.sh attemped to generate a dev version string when CODER_NO_DEV_VERSION was set"
 	fi
-	version+="+dev.$(git rev-parse --short HEAD)"
+	version+="-devel+$(git rev-parse --short HEAD)"
 fi
 
 # Remove the "v" prefix.