Fix new release script to use correct version and hash sum (#507 )

* fix new release script to use correct version and hash sum * update logging behaviour
Added download status, added comparison by hash sum (#474 )
2025-11-17 14:47:30 -05:00 · 2023-09-18 15:01:57 +02:00 · 2023-09-18 14:01:34 +02:00 · 2023-09-18 11:45:33 +02:00 · 2023-09-17 19:35:11 +00:00 · 2023-08-19 12:53:28 +00:00
6 changed files with 111 additions and 93 deletions
--- a/.cmake-format
+++ b/.cmake-format
@@ -1,74 +1,5 @@
+include: ["cmake/.cmake-format-additional_commands-cpm"]
 format:
  tab_size: 2
  line_width: 100
  dangle_parens: true
-
-parse:
-  additional_commands:
-    cpmaddpackage:
-      pargs:
-        nargs: '*'
-        flags: []
-      spelling: CPMAddPackage
-      kwargs: &cpmaddpackagekwargs
-        NAME: 1
-        FORCE: 1
-        VERSION: 1
-        GIT_TAG: 1
-        DOWNLOAD_ONLY: 1
-        GITHUB_REPOSITORY: 1
-        GITLAB_REPOSITORY: 1
-        GIT_REPOSITORY: 1
-        SVN_REPOSITORY: 1
-        SVN_REVISION: 1
-        SOURCE_DIR: 1
-        DOWNLOAD_COMMAND: 1
-        FIND_PACKAGE_ARGUMENTS: 1
-        NO_CACHE: 1
-        GIT_SHALLOW: 1
-        URL: 1
-        URL_HASH: 1
-        URL_MD5: 1
-        DOWNLOAD_NAME: 1
-        DOWNLOAD_NO_EXTRACT: 1
-        HTTP_USERNAME: 1
-        HTTP_PASSWORD: 1
-        EXCLUDE_FROM_ALL: 1
-        SYSTEM: 1
-        SOURCE_SUBDIR: 1
-        OPTIONS: +
-    cpmfindpackage:
-      pargs:
-        nargs: '*'
-        flags: []
-      spelling: CPMFindPackage
-      kwargs: *cpmaddpackagekwargs
-    cpmdeclarepackage:
-      pargs:
-        nargs: '*'
-        flags: []
-      spelling: CPMDeclarePackage
-      kwargs: *cpmaddpackagekwargs
-    packageproject:
-      pargs:
-        nargs: '*'
-        flags: []
-      spelling: packageProject
-      kwargs:
-        NAME: 1
-        VERSION: 1
-        INCLUDE_DIR: 1
-        INCLUDE_DESTINATION: 1
-        BINARY_DIR: 1
-        COMPATIBILITY: 1
-        VERSION_HEADER: 1
-        DEPENDENCIES: +
-    cpmusepackagelock:
-      pargs: 1
-      spelling: CPMUsePackageLock
-    cpmregisterpackage:
-      pargs: 1
-      spelling: CPMRegisterPackage
-    cpmgetpackageversion:
-      pargs: 2
-      spelling: CPMGetPackageVersion
--- a/.github/workflows/publish.yaml
+++ b/.github/workflows/publish.yaml
@@ -15,8 +15,9 @@ jobs:
      - name: Set CPM version by tag
        run: |
          mkdir dist
-          sed "s/1.0.0-development-version/${GITHUB_REF/refs\/tags\/v}/g" cmake/CPM.cmake > dist/CPM.cmake
-          sed "s/1.0.0-development-version/${GITHUB_REF/refs\/tags\/v}/g" cmake/get_cpm.cmake > dist/get_cpm.cmake
+          sed -e "s/1.0.0-development-version/${GITHUB_REF/refs\/tags\/v}/g" cmake/CPM.cmake > dist/CPM.cmake
+          sed -e "s/1.0.0-development-version/${GITHUB_REF/refs\/tags\/v}/g" \
+              -e "s/CPM_HASH_SUM_PLACEHOLDER/$(sha256sum dist/CPM.cmake | cut -d' ' -f1)/" cmake/get_cpm.cmake > dist/get_cpm.cmake

      - name: Upload CPM.cmake to release
        uses: svenstaro/upload-release-action@v1-release
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ It's built as a thin wrapper around CMake's [FetchContent](https://cmake.org/cma

 ## Manage everything

-Any downloadable project or resource can be added as a version-controlled dependency though CPM, it is not necessary to modify or package anything.
+Any downloadable project or resource can be added as a version-controlled dependency through CPM, it is not necessary to modify or package anything.
 Projects using modern CMake are automatically configured and their targets can be used immediately.
 For everything else, the targets can be created manually after the dependency has been downloaded (see the [snippets](#snippets) below for examples).

@@ -324,8 +324,22 @@ If you know others, feel free to add them here through a PR.
        <p align="center"><b>JNGL - easy to use cross-platform 2D game library</b></p>
      </a>
    </td>
-    <td/>
-    <td/>
+    <td>
+      <a href="https://github.com/sillydan1/aaltitoad">
+        <p align="center">
+          <img src="https://github.com/sillydan1/aaltitoad/raw/v1.1.0/.github/resources/logo/toad_only.svg" alt="aaltitoad" width="100pt" />
+        </p>
+        <p align="center"><b>AALTITOAD - verifier and simulator for Tick Tock Automata</b></p>
+      </a>
+    </td>
+    <td>
+      <a href="https://github.com/ZIMO-Elektronik">
+        <p align="center">
+          <img src="https://avatars.githubusercontent.com/u/117935012?s=400&u=9a871a46dd13437f0adcae166e9efbe518ff0b99&v=4" alt="ZIMO-Elektronik" width="100pt" />
+        </p>
+        <p align="center"><b>ZIMO-Elektronik</b></p>
+      </a>
+    </td>
  </tr>
 </table>

--- a/cmake/.cmake-format-additional_commands-cpm
+++ b/cmake/.cmake-format-additional_commands-cpm
@@ -0,0 +1,69 @@
+parse:
+  additional_commands:
+    cpmaddpackage:
+      pargs:
+        nargs: '*'
+        flags: []
+      spelling: CPMAddPackage
+      kwargs: &cpmaddpackagekwargs
+        NAME: 1
+        FORCE: 1
+        VERSION: 1
+        GIT_TAG: 1
+        DOWNLOAD_ONLY: 1
+        GITHUB_REPOSITORY: 1
+        GITLAB_REPOSITORY: 1
+        GIT_REPOSITORY: 1
+        SVN_REPOSITORY: 1
+        SVN_REVISION: 1
+        SOURCE_DIR: 1
+        DOWNLOAD_COMMAND: 1
+        FIND_PACKAGE_ARGUMENTS: 1
+        NO_CACHE: 1
+        GIT_SHALLOW: 1
+        URL: 1
+        URL_HASH: 1
+        URL_MD5: 1
+        DOWNLOAD_NAME: 1
+        DOWNLOAD_NO_EXTRACT: 1
+        HTTP_USERNAME: 1
+        HTTP_PASSWORD: 1
+        EXCLUDE_FROM_ALL: 1
+        SYSTEM: 1
+        SOURCE_SUBDIR: 1
+        OPTIONS: +
+    cpmfindpackage:
+      pargs:
+        nargs: '*'
+        flags: []
+      spelling: CPMFindPackage
+      kwargs: *cpmaddpackagekwargs
+    cpmdeclarepackage:
+      pargs:
+        nargs: '*'
+        flags: []
+      spelling: CPMDeclarePackage
+      kwargs: *cpmaddpackagekwargs
+    packageproject:
+      pargs:
+        nargs: '*'
+        flags: []
+      spelling: packageProject
+      kwargs:
+        NAME: 1
+        VERSION: 1
+        INCLUDE_DIR: 1
+        INCLUDE_DESTINATION: 1
+        BINARY_DIR: 1
+        COMPATIBILITY: 1
+        VERSION_HEADER: 1
+        DEPENDENCIES: +
+    cpmusepackagelock:
+      pargs: 1
+      spelling: CPMUsePackageLock
+    cpmregisterpackage:
+      pargs: 1
+      spelling: CPMRegisterPackage
+    cpmgetpackageversion:
+      pargs: 2
+      spelling: CPMGetPackageVersion
--- a/cmake/CPM.cmake
+++ b/cmake/CPM.cmake
@@ -5,7 +5,7 @@
 # MIT License
 # -----------
 #[[
-  Copyright (c) 2019-2022 Lars Melchior and contributors
+  Copyright (c) 2019-2023 Lars Melchior and contributors

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
@@ -797,7 +797,7 @@ function(CPMAddPackage)
      "${CPM_ARGS_NAME}" "${CPM_ARGS_VERSION}" "${PACKAGE_INFO}" "${CPM_ARGS_UNPARSED_ARGUMENTS}"
    )
    cpm_fetch_package("${CPM_ARGS_NAME}" populated)
-    if(CPM_CACHE_SOURCE AND download_directory)
+    if(CPM_SOURCE_CACHE AND download_directory)
      file(LOCK ${download_directory}/../cmake.lock RELEASE)
    endif()
    if(${populated})
--- a/cmake/get_cpm.cmake
+++ b/cmake/get_cpm.cmake
@@ -1,4 +1,9 @@
+# SPDX-License-Identifier: MIT
+#
+# SPDX-FileCopyrightText: Copyright (c) 2019-2023 Lars Melchior and contributors
+
 set(CPM_DOWNLOAD_VERSION 1.0.0-development-version)
+set(CPM_HASH_SUM "CPM_HASH_SUM_PLACEHOLDER")

 if(CPM_SOURCE_CACHE)
  set(CPM_DOWNLOAD_LOCATION "${CPM_SOURCE_CACHE}/cpm/CPM_${CPM_DOWNLOAD_VERSION}.cmake")
@@ -11,23 +16,21 @@ endif()
 # Expand relative path. This is important if the provided path contains a tilde (~)
 get_filename_component(CPM_DOWNLOAD_LOCATION ${CPM_DOWNLOAD_LOCATION} ABSOLUTE)

-function(download_cpm)
-  message(STATUS "Downloading CPM.cmake to ${CPM_DOWNLOAD_LOCATION}")
-  file(DOWNLOAD
-       https://github.com/cpm-cmake/CPM.cmake/releases/download/v${CPM_DOWNLOAD_VERSION}/CPM.cmake
-       ${CPM_DOWNLOAD_LOCATION}
-  )
-endfunction()
+message(STATUS "Using CPM at ${CPM_DOWNLOAD_LOCATION}")

-if(NOT (EXISTS ${CPM_DOWNLOAD_LOCATION}))
-  download_cpm()
-else()
-  # resume download if it previously failed
-  file(READ ${CPM_DOWNLOAD_LOCATION} check)
-  if("${check}" STREQUAL "")
-    download_cpm()
-  endif()
-  unset(check)
+file(
+  DOWNLOAD
+  https://github.com/cpm-cmake/CPM.cmake/releases/download/v${CPM_DOWNLOAD_VERSION}/CPM.cmake
+  ${CPM_DOWNLOAD_LOCATION}
+  STATUS CPM_DOWNLOAD_STATUS
+  EXPECTED_HASH SHA256=${CPM_HASH_SUM}
+)
+
+list(GET CPM_DOWNLOAD_STATUS 0 CPM_DOWNLOAD_STATUS_CODE)
+if(NOT ${CPM_DOWNLOAD_STATUS_CODE} EQUAL 0)
+  # give a fatal error when download fails
+  list(GET CPM_DOWNLOAD_STATUS 1 CPM_DOWNLOAD_ERROR_MESSAGE)
+  message(FATAL_ERROR "Error occurred during download of CPM: ${CPM_DOWNLOAD_ERROR_MESSAGE}")
 endif()

 include(${CPM_DOWNLOAD_LOCATION})
Author	SHA1	Message	Date
Lars Melchior	52ee7c9d53	Fix new release script to use correct version and hash sum (#507 ) * fix new release script to use correct version and hash sum * update logging behaviour	2023-09-18 15:01:57 +02:00
Tobias Schmidl	699c7a0038	Added download status, added comparison by hash sum (#474 )	2023-09-18 14:01:34 +02:00
Vincent Hamp	daf9d766c6	Add ZIMO-Elektronik to "Built with CPM.cmake" (#490 )	2023-09-18 11:45:33 +02:00
Carlo Corradini	439bfcf134	chore(license): update license year (#504 )	2023-09-17 19:35:11 +00:00
Alois Klink	02ecc4608a	Add SPDX tags to get_cpm.cmake to comply with MIT (#496 ) Add [SPDX][1] licensing/copyright tags to the `get_cpm.cmake` script, so that anybody that copies the `get_cpm.cmake` script into their repo (following the instructions in the README.md) will automatically comply with CPM's MIT license. [1]: https://spdx.dev/	2023-08-19 12:53:28 +00:00
Johel Ernesto Guerrero Peña	4608688d85	docs: fix spelling of "through" (#489 )	2023-08-19 13:29:57 +02:00
Johel Ernesto Guerrero Peña	cda03b434e	ci(cmake): split additional_commands to its own file (#486 )	2023-08-19 12:57:47 +02:00
Andreas K	ee556fc555	fix(lock): fix typo: CPM_CACHE_SOURCE -> CPM_SOURCE_CACHE (#485 )	2023-07-12 15:43:48 +02:00
Asger Gitz-Johansen	1b59cb6b16	Add AALTITOAD to "Built with CPM.cmake" (#463 )	2023-04-13 09:58:49 +00:00