fix: add versioning at build time

also adopt dyne/musl-action in CI (thx @matteo-cristino)

Author: jaromil

.github/workflows/main.yml

@@ -58,14 +58,13 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: ccache
-        uses: hendrikmuhs/ccache-action@v1.2
-      - name: Install dyne muscle
-        run: |
-          curl -L "https://files.dyne.org/?file=musl/dyne-gcc-musl-${OUTPUT}.tar.xz" | sudo tar -C /opt -xJf -
+      - name: Install dyne musl
+        uses: dyne/musl-action@main
+        with:
+          target_arch: x86_64
       - name: Build conspire
         run: |
-          make
+          make VERSION=${{ needs.semantic-release.outputs.new_release_version }}
       - name: Upload release artifact
         uses: actions/upload-artifact@v4
         with:

GNUmakefile

@@ -1,6 +1,7 @@
 # Makefile to download and build it all
 OUTPUT ?= x86_64
 TARGET ?= x86_64-linux-musl
+VERSION ?= dev
 R := $(CURDIR)
 I := $(R)/build/deps
 
@@ -11,7 +12,8 @@ all: build/deps conspire
 
 conspire:
 	cmake -G Ninja -S server -B build -DARCH=$(TARGET) \
-		-DCMAKE_TOOLCHAIN_FILE="/opt/dyne/gcc-musl/settings.cmake"
+		-DCMAKE_TOOLCHAIN_FILE="/opt/dyne/gcc-musl/settings.cmake" \
+		-DVERSION="$(VERSION)"
 	ninja -C build
 	cp build/canchat-exe conspire-$(OUTPUT)
 	/opt/dyne/gcc-musl/bin/$(TARGET)-strip conspire-$(OUTPUT)

server/CMakeLists.txt

@@ -72,12 +72,18 @@ if(EXISTS "${DEPS_PREFIX}")
 endif()
 
 #################################################################
-## define certificates path
+## define version and build paths
+
+# Set version from command line or default
+if(NOT DEFINED VERSION)
+    set(VERSION "unknown")
+endif()
 
 add_definitions(
         -DCERT_PEM_PATH="cert/privkey.pem"
         -DCERT_CRT_PATH="cert/fullchain.pem"
         -DFRONT_PATH="front"
+        -DCONSPIRE_VERSION="${VERSION}"
 )
 
 #################################################################

server/src/App.cpp

@@ -124,10 +124,16 @@ void setupSignalHandlers() {
 
 void run(const oatpp::base::CommandLineArguments& args) {
 
+  // Print version and exit if '--version' is present
+  if(args.hasArgument("--version")) {
+    std::cout << "Conspire Chat Server v" << CONSPIRE_VERSION << std::endl;
+    return;
+  }
+
   // Print help and exit if '-h' or '--help' is present
   if(args.hasArgument("-h") || args.hasArgument("--help")) {
     std::cout << R"HELP(
-Conspire Chat Server
+Conspire Chat Server v)HELP" << CONSPIRE_VERSION << R"HELP(
 Usage: conspire [options]
 Options:
   --host <address>         Bind address (default: localhost)
@@ -137,6 +143,7 @@ Usage: conspire [options]
   --url-stats <path>       Statistics endpoint path (default: admin/stats.json)
   --pid <path>             Path to PID file to create
   --front <path>           Path to frontend static files (default: front)
+  --version                Show version information
   -h, --help               Show this help message
 )HELP" << std::endl;
     return;
@@ -231,6 +238,8 @@ Usage: conspire [options]
     OATPP_LOGi("canchat", "Stats thread exiting cleanly");
   });
 
+  OATPP_LOGi("canchat", "Conspire Chat Server v{} starting up", appConfig->version)
+
   if(appConfig->useTLS) {
     OATPP_LOGi("canchat", "clients are expected to connect at https://{}:{}/", appConfig->host, appConfig->port);
   } else {

server/src/AppComponent.hpp

@@ -125,6 +125,9 @@ class AppComponent {
     // Parse --front argument for frontend path
     config->frontPath = m_cmdArgs.getNamedArgumentValue("--front", "front");
 
+    // Set version from build-time definition
+    config->version = CONSPIRE_VERSION;
+
     return config;
 
   }());

server/src/dto/Config.hpp

@@ -65,6 +65,11 @@ class ConfigDto : public oatpp::DTO {
      */
     DTO_FIELD(String, frontPath);
 
+  /**
+   * Software version.
+   */
+  DTO_FIELD(String, version);
+
   /**
    * Max size of the received bytes. (the whole MessageDto structure).
    * The actual payload is smaller.