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>
This commit is contained in:
Rafael Kitover 2024-09-07 06:30:14 +00:00
parent 67e4944cdb
commit 3bd7c918cc
No known key found for this signature in database
GPG Key ID: 08AB596679D86240
2 changed files with 31 additions and 45 deletions

View File

@ -5,6 +5,13 @@ set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
if(WIN32) if(WIN32)
include(RemoveStrawberryPerlFromPATH) include(RemoveStrawberryPerlFromPATH)
find_program(POWERSHELL
NAMES powershell.exe pwsh.exe
HINTS "/Windows/System32/WindowsPowerShell/v1.0"
REQUIRED)
else()
find_program(POWERSHELL pwsh)
endif() endif()
if(UPDATE_APPCAST) if(UPDATE_APPCAST)
@ -23,15 +30,6 @@ set(VCPKG_DEPS_OPTIONAL
faudio ENABLE_FAUDIO 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) include(Set-Toolchain-vcpkg)
# Use ccache if available and not already enabled on the command line. # Use ccache if available and not already enabled on the command line.

View File

@ -10,10 +10,6 @@ if(NOT EXISTS "${CMAKE_SOURCE_DIR}/.git")
message(FATAL_ERROR "releases can only be done from a git clone") message(FATAL_ERROR "releases can only be done from a git clone")
endif() endif()
if(NOT GIT_FOUND)
message(FATAL_ERROR "git is required to make a release")
endif()
find_program(GPG_EXECUTABLE gpg) find_program(GPG_EXECUTABLE gpg)
if(NOT GPG_EXECUTABLE) if(NOT GPG_EXECUTABLE)
@ -35,7 +31,7 @@ function(make_release_commit_and_tag)
# First make sure we are on master. # First make sure we are on master.
execute_process( 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_VARIABLE git_branch
OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_STRIP_TRAILING_WHITESPACE
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
@ -46,7 +42,7 @@ function(make_release_commit_and_tag)
endif() endif()
execute_process( execute_process(
COMMAND ${GIT_EXECUTABLE} status --porcelain=2 COMMAND git status --porcelain=2
OUTPUT_VARIABLE git_status OUTPUT_VARIABLE git_status
OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_STRIP_TRAILING_WHITESPACE
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
@ -59,7 +55,7 @@ function(make_release_commit_and_tag)
endif() endif()
execute_process( execute_process(
COMMAND ${GIT_EXECUTABLE} tag --sort=-v:refname COMMAND git tag --sort=-v:refname
OUTPUT_VARIABLE git_tags OUTPUT_VARIABLE git_tags
OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_STRIP_TRAILING_WHITESPACE
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
@ -80,7 +76,7 @@ function(make_release_commit_and_tag)
endif() endif()
execute_process( 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_VARIABLE release_log
OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_STRIP_TRAILING_WHITESPACE
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
@ -90,17 +86,17 @@ function(make_release_commit_and_tag)
if(TAG_RELEASE STREQUAL UNDO) if(TAG_RELEASE STREQUAL UNDO)
execute_process( execute_process(
COMMAND ${GIT_EXECUTABLE} tag -d ${git_last_tag} COMMAND git tag -d ${git_last_tag}
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
) )
execute_process( execute_process(
COMMAND ${GIT_EXECUTABLE} reset HEAD~1 COMMAND git reset HEAD~1
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
) )
execute_process( execute_process(
COMMAND ${GIT_EXECUTABLE} checkout HEAD CHANGELOG.md COMMAND git checkout HEAD CHANGELOG.md
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
) )
@ -212,45 +208,37 @@ Ignore the following cmake error.
) )
execute_process( execute_process(
COMMAND ${GIT_EXECUTABLE} add CHANGELOG.md COMMAND git add CHANGELOG.md
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
) )
# Make the release commit. message(FATAL_ERROR "
execute_process( Release prepared.
COMMAND ${GIT_EXECUTABLE} commit -m "release ${new_tag}" --signoff -S
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
)
# Make release tag. Edit CHANGELOG.md to remove any non-user-facing commits, and optionally add any
release notes.
execute_process( Run the following commands to commit the change:
COMMAND ${GIT_EXECUTABLE} tag -s -m${new_tag} ${new_tag}
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
)
message(FATAL_ERROR [=[ git commit -m'release ${new_tag}' --signoff -S
git tag -s -m'${new_tag}' ${new_tag}
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 ****
To rollback these changes, run this command: To rollback these changes, run this command:
cmake .. -DTAG_RELEASE=UNDO 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. build anything.
]=]) ")
endfunction() endfunction()
make_release_commit_and_tag() make_release_commit_and_tag()