Moving releases to GitHub Action pipeline

Moving to go 1.20 reruning dependencies
Using up to date gclpr
Vendoring npiperelay
Linting with latest staticcheck

Author: rupor-github

.github/workflows/release.yml

@@ -0,0 +1,63 @@
+name: wsl-ssh-agent release
+
+on:
+  create:
+    tags:
+    - "v*.*.*"
+
+permissions:
+  contents: write
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+
+    - uses: actions/checkout@v3
+    - uses: awalsh128/cache-apt-pkgs-action@latest
+      with:
+        packages: binutils-mingw-w64-x86-64
+        version: 1.0
+ 
+    - name: Ubuntu version
+      run: lsb_release -a
+
+    - name: Get latest CMake and Ninja
+      uses: lukka/get-cmake@latest
+      with:
+        cmakeVersion: latest
+        ninjaVersion: latest
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: '1.20'
+
+    - name: Build - win64
+      env:
+        MSYSTEM_NAME: win64
+      run: |
+        cmake -G Ninja -B build_win64
+        cmake --build build_win64 --target release
+
+    - name: Sign release artifacts
+      # After lunar this could be replaced with "apt install minisign"
+      uses: thomasdesr/minisign-action@v1
+      with:
+        args: -Sm gclpr_*.zip
+        minisign_key: ${{ secrets.minisign_key }}
+        password: ${{ secrets.minisign_password }}
+
+    - name: List results
+      run: ls -lah wsl-ssh-*
+
+    - name: Upload release
+      uses: softprops/action-gh-release@v1
+      if: startsWith(github.ref, 'refs/tags/')
+      with:
+        generate_release_notes: true
+        files: |
+          wsl-ssh-agent.json
+          wsl-ssh-agent.zip
+          wsl-ssh-agnt.zip.minisig

.gitignore

@@ -12,9 +12,7 @@
 *.syso
 
 build/
-release/
-
-# build specific
+build_*/
 misc/version.go
 cmd/*/resources.rc
 cmd/*/manifest.xml

CMakeLists.txt

@@ -1,44 +1,35 @@
-cmake_minimum_required(VERSION 3.0)
+cmake_minimum_required(VERSION 3.18)
+
+project(wsl-ssh-agent NONE)
 
 message(STATUS "Running cmake version ${CMAKE_VERSION}")
-if (NOT CMAKE_TOOLCHAIN_FILE)
-    set(CMAKE_TOOLCHAIN_FILE "../cmake/win64.toolchain" CACHE STRING "default toolchain" FORCE)
-endif()
 if (NOT CMAKE_BUILD_TYPE)
     set(CMAKE_BUILD_TYPE "Release" CACHE STRING "default to release build type" FORCE)
 endif()
-
-project(wsl-ssh-agent NONE)
-set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_SOURCE_DIR}/cmake)
-
+set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release")
 message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
 message(STATUS "Generator: ${CMAKE_GENERATOR}")
 
-# Release installation directory
-if(NOT CMAKE_CROSSCOMPILING)
-    message(FATAL_ERROR "Currently unsuppored environment. CMake willl exit now.")
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_SOURCE_DIR}/cmake)
+
+if (NOT "$ENV{MSYSTEM_NAME}" STREQUAL "")
+    set(MSYSTEM_NAME "$ENV{MSYSTEM_NAME}" CACHE INTERNAL "Copied from environment")
 else()
-    set(HOST_GOOS linux)
-    set(HOST_GOARCH amd64)
+    set(MSYSTEM_NAME "linux_amd64" CACHE INTERNAL "Host environment")
 endif()
 
-if(MSYSTEM_NAME STREQUAL "win32")
-    set(CROSS_GOOS windows)
-    set(CROSS_GOARCH 386)
-    message(STATUS "Targeting 32 bits Windows executable")
-elseif(MSYSTEM_NAME STREQUAL "win64")
+if(MSYSTEM_NAME STREQUAL "win64")
     set(CROSS_GOOS windows)
     set(CROSS_GOARCH amd64)
+     # we are not using cmake cross compilation abilities
+    set(CROSS_EXECUTABLE_SUFFIX ".exe")
+    find_program(CROSS_RC_COMPILER x86_64-w64-mingw32-windres PATHS usr PATH_SUFFIXES bin DOC "Windows resource compiler path" REQUIRED)
     message(STATUS "Targeting 64 bits Windows executable")
 else()
-    message(FATAL_ERROR "Currently unsuppored environment \"${MSYSTEM_NAME}\". CMake willl exit now.")
+    message(FATAL_ERROR "Currently unsuppored environment \"${MSYSTEM_NAME}\".")
 endif()
 
-set(DEST_DIR "${PROJECT_SOURCE_DIR}/bin")
-message(STATUS "Installation directory: ${DEST_DIR}")
-
-set(GO_MIN_REQURED_VERSION 1.19)
-find_package(Go ${GO_MIN_REQURED_VERSION} REQUIRED)
+find_package(Go REQUIRED)
 find_package(Git REQUIRED)
 
 # Make sure we setup go properly
@@ -57,12 +48,21 @@ endif()
 # Setting up versioning
 ########################################################################################################
 
-# Project version number
-set(PRJ_VERSION_Major "1")
-set(PRJ_VERSION_Minor "6")
-set(PRJ_VERSION_Patch "3")
+# Project version number - comes from release version tag
+set(GIT_REF $ENV{GITHUB_REF})
+if(GIT_REF MATCHES "refs/tags/v([0-9]+)\\.([0-9]+)\\.([0-9]+)")
+    set(PRJ_VERSION_Major ${CMAKE_MATCH_1})
+    set(PRJ_VERSION_Minor ${CMAKE_MATCH_2})
+    set(PRJ_VERSION_Patch ${CMAKE_MATCH_3})
+else()
+    set(PRJ_VERSION_Major 0)
+    set(PRJ_VERSION_Minor 0)
+    set(PRJ_VERSION_Patch 0)
+endif()
 
-if (EXISTS "${PROJECT_SOURCE_DIR}/.git" AND IS_DIRECTORY "${PROJECT_SOURCE_DIR}/.git")
+if(DEFINED ENV{GITHUB_SHA})
+    set(GIT_HASH "$ENV{GITHUB_SHA}")
+elseif(EXISTS "${PROJECT_SOURCE_DIR}/.git" AND IS_DIRECTORY "${PROJECT_SOURCE_DIR}/.git")
     execute_process(COMMAND ${CMAKE_SOURCE_DIR}/cmake/githash.sh ${GIT_EXECUTABLE}
         WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
         RESULT_VARIABLE res
@@ -75,25 +75,25 @@ else()
     set(GIT_HASH "no-git")
 endif()
 configure_file("${PROJECT_SOURCE_DIR}/cmake/version.go.in" "${PROJECT_SOURCE_DIR}/misc/version.go")
-configure_file("${PROJECT_SOURCE_DIR}/cmake/agent.rc.in" "${PROJECT_SOURCE_DIR}/cmd/agent/resources.rc")
-configure_file("${PROJECT_SOURCE_DIR}/cmake/agent.xml.in" "${PROJECT_SOURCE_DIR}/cmd/agent/manifest.xml")
-configure_file("${PROJECT_SOURCE_DIR}/cmake/wsl-ssh-agent.json.in" "${PROJECT_SOURCE_DIR}/wsl-ssh-agent.json")
-
-# for user convinience
-execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/../../jstarks/npiperelay/npiperelay.exe ${PROJECT_BINARY_DIR})
-
-# distribute history
-execute_process(COMMAND ${CMAKE_COMMAND} -E env ${GIT_EXECUTABLE} changelog --all --tag "v${PRJ_VERSION_Major}.${PRJ_VERSION_Minor}.${PRJ_VERSION_Patch}" --stdout OUTPUT_FILE ${PROJECT_BINARY_DIR}/changelog.txt ERROR_QUIET)
-
-message(STATUS "Building version \"${PRJ_VERSION_Major}.${PRJ_VERSION_Minor}.${PRJ_VERSION_Patch}\" git \"${GIT_HASH}\"")
 
 if(CMAKE_BUILD_TYPE STREQUAL "Debug")
-    # Create git pre-commit hook to check formatting before commit
+    # Create local git hooks
     if(EXISTS "${PROJECT_SOURCE_DIR}/.git" AND IS_DIRECTORY "${PROJECT_SOURCE_DIR}/.git")
         execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_SOURCE_DIR}/cmake/pre-commit ${PROJECT_SOURCE_DIR}/.git/hooks/. WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
+        configure_file("${PROJECT_SOURCE_DIR}/cmake/pre-push" "${PROJECT_SOURCE_DIR}/.git/hooks/pre-push" @ONLY)
     endif()
 endif()
 
+if(CROSS_GOOS STREQUAL "windows")
+    if(NOT EXISTS "${PROJECT_SOURCE_DIR}/gclpr.json")
+        configure_file("${PROJECT_SOURCE_DIR}/cmake/wsl-ssh-agent.json.in" "${PROJECT_SOURCE_DIR}/wsl-ssh-agent.json" @ONLY)
+    endif()
+    configure_file("${PROJECT_SOURCE_DIR}/cmake/agent.rc.in" "${PROJECT_SOURCE_DIR}/cmd/gui/resources.rc" @ONLY)
+    configure_file("${PROJECT_SOURCE_DIR}/cmake/agent.xml.in" "${PROJECT_SOURCE_DIR}/cmd/gui/manifest.xml" @ONLY)
+endif()
+
+message(STATUS "Building version \"${PRJ_VERSION_Major}.${PRJ_VERSION_Minor}.${PRJ_VERSION_Patch}\" git \"${GIT_HASH}\"")
+
 ########################################################################################################
 # Some contexts dependent settings
 ########################################################################################################
@@ -102,12 +102,14 @@ list(APPEND GO_ENV
     GOPATH=${GO_PATH}
     GOOS=${CROSS_GOOS}
     GOARCH=${CROSS_GOARCH}
+    CGO_ENABLED=0
     )
 
 if(CMAKE_BUILD_TYPE STREQUAL "Debug")
-    set(GO_ARGS "-mod=mod")
+    set(TEST_RUN_ARGS "-v")
+    set(GO_MOD_ARGS "-mod=mod")
 else()
-    set(GO_ARGS "-mod=vendor")
+    set(GO_MOD_ARGS "-mod=vendor")
 endif()
 
 ########################################################################################################
@@ -117,38 +119,43 @@ endif()
 add_custom_target(release
     DEPENDS ${PROJECT_SOURCE_DIR}/wsl-ssh-agent.zip
         ${PROJECT_SOURCE_DIR}/wsl-ssh-agent.json
-    COMMAND ${CMAKE_SOURCE_DIR}/cmake/sign.sh
+    COMMAND ${CMAKE_SOURCE_DIR}/cmake/scoophash.sh ${MSYSTEM_NAME}
     COMMENT "Building release..."
     WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}")
 
 add_custom_command(OUTPUT ${PROJECT_SOURCE_DIR}/wsl-ssh-agent.zip
-    DEPENDS ${PROJECT_BINARY_DIR}/changelog.txt
-        ${PROJECT_BINARY_DIR}/npiperelay${CMAKE_EXECUTABLE_SUFFIX}
-        ${PROJECT_BINARY_DIR}/wsl-ssh-agent-gui${CMAKE_EXECUTABLE_SUFFIX}
+    DEPENDS ${PROJECT_BINARY_DIR}/npiperelay${CROSS_EXECUTABLE_SUFFIX}
+        ${PROJECT_BINARY_DIR}/wsl-ssh-agent-gui${CROSS_EXECUTABLE_SUFFIX}
     COMMAND ${CMAKE_COMMAND} -E tar "cfv" ${PROJECT_SOURCE_DIR}/wsl-ssh-agent.zip --format=zip
-        changelog.txt npiperelay${CMAKE_EXECUTABLE_SUFFIX} wsl-ssh-agent-gui${CMAKE_EXECUTABLE_SUFFIX}
+        npiperelay${CROSS_EXECUTABLE_SUFFIX} wsl-ssh-agent-gui${CROSS_EXECUTABLE_SUFFIX}
     COMMENT "Archiving release..."
     WORKING_DIRECTORY "${PROJECT_BINARY_DIR}")
 
 add_custom_target(bin_agent ALL
     DEPENDS ${PROJECT_SOURCE_DIR}/cmd/agent/resources.syso
-    BYPRODUCTS ${PROJECT_BINARY_DIR}/wsl-ssh-agent-gui${CMAKE_EXECUTABLE_SUFFIX}
-    COMMAND ${GO_ENV} ${GO_EXECUTABLE} build -trimpath -o ${PROJECT_BINARY_DIR}/wsl-ssh-agent-gui${CMAKE_EXECUTABLE_SUFFIX}
+    BYPRODUCTS ${PROJECT_BINARY_DIR}/wsl-ssh-agent-gui${CROSS_EXECUTABLE_SUFFIX}
+    COMMAND ${GO_ENV} ${GO_EXECUTABLE} build ${GO_MOD_ARGS} -trimpath -o ${PROJECT_BINARY_DIR}/wsl-ssh-agent-gui${CROSS_EXECUTABLE_SUFFIX}
         -ldflags='-H=windowsgui'
-        ${GO_ARGS}
         ./cmd/agent
     COMMENT "Building wsl-ssh-agent-gui..."
     WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}")
 
 add_custom_command(OUTPUT ${PROJECT_SOURCE_DIR}/cmd/agent/resources.syso
-     DEPENDS ${PROJECT_SOURCE_DIR}/cmd/agent/resources.rc
-         ${PROJECT_SOURCE_DIR}/cmd/agent/manifest.xml
-         ${PROJECT_SOURCE_DIR}/cmd/agent/icon.ico
-     COMMAND ${CMAKE_RC_COMPILER} -O coff
-         -o ${PROJECT_SOURCE_DIR}/cmd/agent/resources.syso
-         -i ${PROJECT_SOURCE_DIR}/cmd/agent/resources.rc
-     WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
-     COMMENT "Building wsl-ssh-agent-gui resources...")
+    DEPENDS ${PROJECT_SOURCE_DIR}/cmd/agent/resources.rc
+        ${PROJECT_SOURCE_DIR}/cmd/agent/manifest.xml
+        ${PROJECT_SOURCE_DIR}/cmd/agent/icon.ico
+    COMMAND ${CROSS_RC_COMPILER} -O coff
+        -o ${PROJECT_SOURCE_DIR}/cmd/agent/resources.syso
+        -i ${PROJECT_SOURCE_DIR}/cmd/agent/resources.rc
+    WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
+    COMMENT "Building wsl-ssh-agent-gui resources...")
+
+add_custom_target(bin_npiperelay
+    BYPRODUCTS ${PROJECT_BINARY_DIR}/npiperelay${CROSS_EXECUTABLE_SUFFIX}
+    COMMAND ${GO_ENV} ${GO_EXECUTABLE} build ${GO_MOD_ARGS} -trimpath -o ${PROJECT_BINARY_DIR}/npiperelay${CROSS_EXECUTABLE_SUFFIX}
+        github.com/jstarks/npiperelay
+    COMMENT "Building npiperelay..."
+    WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}")
 
 ########################################################################################################
 # Development
@@ -178,7 +185,7 @@ if(CMAKE_BUILD_TYPE STREQUAL "Debug")
 
     add_custom_target(deps_tidy
         SOURCES ${PROJECT_SOURCE_DIR}/go.mod
-        COMMAND ${GO_ENV} ${GO_EXECUTABLE} mod tidy -compat=${GO_MIN_REQURED_VERSION}
+        COMMAND ${GO_ENV} ${GO_EXECUTABLE} mod tidy -go=${GO_LANG_VERSION}
         WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
         COMMENT "Cleaning dependencies (go mod tidy)"
         VERBATIM)

cmake/FindGo.cmake

@@ -5,44 +5,33 @@
 # The module defines the following variables:
 #   GO_FOUND - true if the Go was found
 #   GO_EXECUTABLE - path to the executable
+#   GOFMT_EXECUTABLE - path to gofmt executable
 #   GO_VERSION - Go version number
+#   GO_LANG_VERSION - Go version number without patch, only major and minor versions. Used with "go mod tidy"
 #   GO_PLATFORM - i.e. linux
 #   GO_ARCH - i.e. amd64
 # Example usage:
 #   find_package(Go 1.2 REQUIRED)
 
-find_program(GO_EXECUTABLE go PATHS $ENV{HOME}/go ENV GOROOT GOPATH PATH_SUFFIXES bin)
+find_program(GO_EXECUTABLE go PATHS ENV GOROOT GOPATH PATH_SUFFIXES bin)
 if(GO_EXECUTABLE)
-    if(NOT CMAKE_CROSSCOMPILING AND WIN32 AND DEFINED ENV{MSYSTEM})
-        if(NOT GO_ROOT)
-            if($ENV{MSYSTEM} STREQUAL "MINGW32")
-                set(GO_ROOT "/mingw32/lib/go")
-            elseif($ENV{MSYSTEM} STREQUAL "MINGW64")
-                set(GO_ROOT "/mingw64/lib/go")
-            else()
-                message(FATAL_ERROR "Currently unsuppored environment. CMake willl exit now.")
-            endif()
-        endif()
-    else()
-	if (DEFINED ENV{GOROOT})
- 		set(GO_ROOT "$ENV{GOROOT}")
-	else()
- 		set(GO_ROOT "/usr/lib/go")
-	endif()
-    endif()
-    execute_process(COMMAND sh -c "${GO_EXECUTABLE} version" OUTPUT_VARIABLE GO_VERSION_OUTPUT OUTPUT_STRIP_TRAILING_WHITESPACE)
-    if(GO_VERSION_OUTPUT MATCHES "go([0-9]+\\.[0-9]+\\.?[0-9]*)[a-zA-Z0-9]* ([^/]+)/(.*)")
+	execute_process(COMMAND ${GO_EXECUTABLE} version OUTPUT_VARIABLE GO_VERSION_OUTPUT OUTPUT_STRIP_TRAILING_WHITESPACE)
+    if(GO_VERSION_OUTPUT MATCHES "go version go([0-9]+\\.[0-9]+\\.?[0-9]*)[a-zA-Z0-9]* ([^/]+)/(.*)")
         set(GO_VERSION ${CMAKE_MATCH_1})
         set(GO_PLATFORM ${CMAKE_MATCH_2})
         set(GO_ARCH ${CMAKE_MATCH_3})
+        string(REGEX MATCH "([0-9]+\\.[0-9]+)" GO_LANG_VERSION ${GO_VERSION})
     elseif(GO_VERSION_OUTPUT MATCHES "go version devel .* ([^/]+)/(.*)$")
         set(GO_VERSION "99-devel")
+        set(GO_LANG_VERSION, "99-devel")
         set(GO_PLATFORM ${CMAKE_MATCH_1})
         set(GO_ARCH ${CMAKE_MATCH_2})
         message("WARNING: Development version of Go being used, can't determine compatibility.")
     endif()
+    get_filename_component(path ${GO_EXECUTABLE} DIRECTORY)
+    set(GOFMT_EXECUTABLE ${path}/gofmt${CMAKE_EXECUTABLE_SUFFIX})
 endif()
 mark_as_advanced(GO_EXECUTABLE)
 
 include(FindPackageHandleStandardArgs)
-find_package_handle_standard_args(Go REQUIRED_VARS GO_EXECUTABLE GO_VERSION GO_PLATFORM GO_ARCH VERSION_VAR GO_VERSION)
+find_package_handle_standard_args(Go REQUIRED_VARS GO_EXECUTABLE GOFMT_EXECUTABLE GO_PLATFORM GO_ARCH GO_VERSION GO_LANG_VERSION VERSION_VAR GO_VERSION)

cmake/pre-push

@@ -0,0 +1,29 @@
+#!/bin/bash
+# To use, store as .git/hooks/pre-push inside your repository and make sure
+# it has execute permissions.
+
+# run security/vulnerabilities scanner prior to pushing to repo
+
+cd @PROJECT_SOURCE_DIR@
+# Check if we actually have commits to push
+commits=`git log @{u}..`
+if [ -z "$commits" ]; then
+    exit 0
+fi
+
+scanner=trivy
+
+echo "==== running vulnerabilities scanner (${scanner}) from $0"
+echo "     to accept risks create a .trivyignore file in repo's root"
+echo "     See https://github.com/aquasecurity/trivy/blob/main/docs/docs/vulnerability/examples/filter.md#by-vulnerability-ids"
+echo
+
+# detect if "trivy" is installed
+which ${scanner} > /dev/null
+if [[ $? != 0 ]]; then
+  echo "to install ${scanner} follow instructions on https://github.com/aquasecurity/trivy/blob/main/docs/getting-started/installation.md#debianubuntu"
+  exit 1
+fi
+
+# without the --exit-code 1 flag - trivy always exists with 0
+${scanner} --exit-code 1 fs --ignore-unfixed .

cmake/scoophash.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+if [ "${1}" = "win32" ] || [ "${1}" = "win64" ]; then
+
+    hash=`sha256sum -z wsl-ssh-agent.zip | awk '{ print $1; }'`
+    sed -i -e "s/__CURRENT_HASH_${1}__/${hash}/g" wsl-ssh-agent.json
+
+fi

cmake/sign.sh

@@ -1,5 +1,9 @@
 package misc
 
+func GetMagic() []byte {
+	return []byte{'g', 'c', 'l', 'p', 'r', @PRJ_VERSION_Major@, @PRJ_VERSION_Minor@, @PRJ_VERSION_Patch@}
+}
+
 func GetVersion() string {
 	return "@PRJ_VERSION_Major@.@PRJ_VERSION_Minor@.@PRJ_VERSION_Patch@"
 }