From 3bd7c918cc7eb93e1f5683c0cefa9599b88275c9 Mon Sep 17 00:00:00 2001
From: Rafael Kitover <rkitover@gmail.com>
Date: Sat, 7 Sep 2024 06:30:14 +0000
Subject: [PATCH] build: fix cmake -DTAG_RELEASE functionality

Update the cmake -DTAG_RELEASE script to work with recent cmake changes.

Change it to not automatically make the release commit and tag, instead
specifying in the instructions that the person making the release must
edit the CHANGELOG.md and then run the commands, given in the
instructions, to make the release commit and tag.

Signed-off-by: Rafael Kitover <rkitover@gmail.com>
---
 CMakeLists.txt                      | 16 ++++----
 cmake/MakeReleaseCommitAndTag.cmake | 60 ++++++++++++-----------------
 2 files changed, 31 insertions(+), 45 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 83dc9106..c03f8f9c 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -5,6 +5,13 @@ set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
 
 if(WIN32)
     include(RemoveStrawberryPerlFromPATH)
+
+    find_program(POWERSHELL
+        NAMES powershell.exe pwsh.exe
+        HINTS "/Windows/System32/WindowsPowerShell/v1.0"
+        REQUIRED)
+else()
+    find_program(POWERSHELL pwsh)
 endif()
 
 if(UPDATE_APPCAST)
@@ -23,15 +30,6 @@ set(VCPKG_DEPS_OPTIONAL
     faudio ENABLE_FAUDIO
 )
 
-if(WIN32)
-    find_program(POWERSHELL
-        NAMES powershell.exe pwsh.exe
-        HINTS "/Windows/System32/WindowsPowerShell/v1.0"
-        REQUIRED)
-else()
-    find_program(POWERSHELL pwsh)
-endif()
-
 include(Set-Toolchain-vcpkg)
 
 # Use ccache if available and not already enabled on the command line.
diff --git a/cmake/MakeReleaseCommitAndTag.cmake b/cmake/MakeReleaseCommitAndTag.cmake
index 3a8ee183..32fe79ed 100644
--- a/cmake/MakeReleaseCommitAndTag.cmake
+++ b/cmake/MakeReleaseCommitAndTag.cmake
@@ -10,10 +10,6 @@ if(NOT EXISTS "${CMAKE_SOURCE_DIR}/.git")
     message(FATAL_ERROR "releases can only be done from a git clone")
 endif()
 
-if(NOT GIT_FOUND)
-    message(FATAL_ERROR "git is required to make a release")
-endif()
-
 find_program(GPG_EXECUTABLE gpg)
 
 if(NOT GPG_EXECUTABLE)
@@ -35,7 +31,7 @@ function(make_release_commit_and_tag)
     # First make sure we are on master.
 
     execute_process(
-        COMMAND ${GIT_EXECUTABLE} rev-parse --short --abbrev-ref=strict HEAD
+        COMMAND git rev-parse --short --abbrev-ref=strict HEAD
         OUTPUT_VARIABLE git_branch
         OUTPUT_STRIP_TRAILING_WHITESPACE
         WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
@@ -46,7 +42,7 @@ function(make_release_commit_and_tag)
     endif()
 
     execute_process(
-        COMMAND ${GIT_EXECUTABLE} status --porcelain=2
+        COMMAND git status --porcelain=2
         OUTPUT_VARIABLE git_status
         OUTPUT_STRIP_TRAILING_WHITESPACE
         WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
@@ -59,7 +55,7 @@ function(make_release_commit_and_tag)
     endif()
 
     execute_process(
-        COMMAND ${GIT_EXECUTABLE} tag --sort=-v:refname
+        COMMAND git tag --sort=-v:refname
         OUTPUT_VARIABLE git_tags
         OUTPUT_STRIP_TRAILING_WHITESPACE
         WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
@@ -80,7 +76,7 @@ function(make_release_commit_and_tag)
     endif()
 
     execute_process(
-        COMMAND ${GIT_EXECUTABLE} log ${git_last_tag}.. "--pretty=format:* %h - %s [%aL]"
+        COMMAND git log ${git_last_tag}.. "--pretty=format:* %h - %s [%aL]"
         OUTPUT_VARIABLE release_log
         OUTPUT_STRIP_TRAILING_WHITESPACE
         WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
@@ -90,17 +86,17 @@ function(make_release_commit_and_tag)
 
     if(TAG_RELEASE STREQUAL UNDO)
         execute_process(
-            COMMAND ${GIT_EXECUTABLE} tag -d ${git_last_tag}
+            COMMAND git tag -d ${git_last_tag}
             WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
         )
 
         execute_process(
-            COMMAND ${GIT_EXECUTABLE} reset HEAD~1
+            COMMAND git reset HEAD~1
             WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
         )
 
         execute_process(
-            COMMAND ${GIT_EXECUTABLE} checkout HEAD CHANGELOG.md
+            COMMAND git checkout HEAD CHANGELOG.md
             WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
         )
 
@@ -212,45 +208,37 @@ Ignore the following cmake error.
     )
 
     execute_process(
-        COMMAND ${GIT_EXECUTABLE} add CHANGELOG.md
+        COMMAND git add CHANGELOG.md
         WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
     )
 
-    # Make the release commit.
+    message(FATAL_ERROR "
 
-    execute_process(
-        COMMAND ${GIT_EXECUTABLE} commit -m "release ${new_tag}" --signoff -S
-        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-    )
+Release prepared.
 
-    # Make release tag.
+Edit CHANGELOG.md to remove any non-user-facing commits, and optionally add any
+release notes.
 
-    execute_process(
-        COMMAND ${GIT_EXECUTABLE} tag -s -m${new_tag} ${new_tag}
-        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-    )
+Run the following commands to commit the change:
 
-    message(FATAL_ERROR [=[
-
-Release commit and tag generated.
-
-**** IF YOU ARE SURE YOU WANT TO RELEASE ****
-
-Run the following commands to push the release commit and tag:
-
-    git push
-    git push --tags
-
-**** TO UNDO THE RELEASE ****
+    git commit -m'release ${new_tag}' --signoff -S
+    git tag -s -m'${new_tag}' ${new_tag}
 
 To rollback these changes, run this command:
 
     cmake .. -DTAG_RELEASE=UNDO
 
-Ignore the "configuration incomplete" message following, this mode does not
+==== IF YOU ARE SURE YOU WANT TO RELEASE, THIS **CANNOT** BE REVERSED ====
+
+Run the following to push the release commit and tag:
+
+    git push
+    git push --tags
+
+Ignore the 'configuration incomplete' message following, this mode does not
 build anything.
 
-]=])
+")
 endfunction()
 
 make_release_commit_and_tag()