Updated the release yaml and now have a script to validate the input against the current project version

Author: LinuxDevon

.github/data/release_body.md

@@ -0,0 +1,19 @@
+# Libdbc release
+
+### Developer Notes
+
+**TODO: Update this!**
+
+## Breaking Changes
+
+* <Insert-Change>
+
+## Features
+
+* <Insert-Change>
+
+## Bugs
+
+* <Insert-Change>
+
+

.github/workflows/pipeline.yml

@@ -1,6 +1,6 @@
 name: Libdbc Pipeline
 
-on: [push]
+on: [push, workflow_call]
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)

.github/workflows/release.yml

@@ -5,23 +5,80 @@ on:
     inputs:
       major:
         required: true
-        type: string
+        description: "The major version"
+        type: number
       minor:
         required: true
-        type: string
+        description: "The minor version"
+        type: number
       patch:
         required: true
-        type: string
+        description: "The patch version"
+        type: number
+
+      release_type:
+        type: choice
+        description: "The type of release you are making. Controls branch naming / creation"
+        options:
+          - patch
+          - minor
+          - major
 
 jobs:
+  check_version:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: "Validate version in cmake before continuing"
+        run: ./scripts/check_version.py --version "v${{ inputs.major }}.${{ inputs.minor }}.${{ inputs.patch }}"
+
+  pipeline:
+    runs-on: ubuntu-latest
+    needs: [check_version]
+    uses: ./.github/workflows/pipeline.yml
+
   create_release:
     runs-on: ubuntu-latest
+    needs: [pipeline]
+
+    env:
+      header_file_path: build/single_header/libdbc/libdbc.hpp
+
     steps:
-      - name: "Checkout the code"
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
+      - name: "Setup Cargo"
+        run: |
+          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+          source "$HOME/.cargo/env"
+
+      - name: "Generate the header only library"
+        run: ./scripts/create_single_header.sh
+
+      - uses: actions/upload-artifact@v4
+        with:
+          if-no-files-found: error
+          name: header-only
+          path: ${{ env.header_file_path }}
+
+      - name: "Create a branch if we are making a major / minor release"
+        uses: peterjgrainger/[email protected]
+        if: ${{ inputs.major }} || ${{ inputs.minor }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          branch: 'release/v${{ inputs.major }}.${{ inputs.minor }}'
+          sha: '${{ github.sha }}'
 
-      - name: "Run tests as a pre check"
-        uses: .github/workflows/tests.yml
+      - uses: ncipollo/release-action@v1
+        with:
+          artifacts: "${{ env.header_file_path }}"
+          draft: true
+          bodyFile: ".github/workflows/release_body.md"
+          tag: v${{ inputs.major }}.${{ inputs.minor }}.${{ inputs.patch }}
+          commit: release/v${{ inputs.major }}.${{ inputs.minor }}
 
 
 

CMakeLists.txt

@@ -1,9 +1,7 @@
 cmake_minimum_required(VERSION 3.16)
 
-project(dbc
-	VERSION 0.2.0
-	DESCRIPTION "C++ DBC Parser"
-)
+# Keep this on one line for release checking
+project(dbc VERSION 0.2.0 DESCRIPTION "C++ DBC Parser")
 
 # -- PROJECT OPTIONS  -- #
 option(DBC_ENABLE_TESTS "Enable Unittests" ON)

scripts/check_version.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python3
+# Used to check the input verion against the input
+import re
+import argparse
+
+
+def get_cmake_version(cmake_file):
+    with open(cmake_file, 'r') as f:
+        contents = f.read()
+        match = re.search(r'project\(.*VERSION (\d+)\.(\d+)\.(\d+)', contents)
+        if match:
+            major, minor, patch = map(int, match.groups())
+            return major, minor, patch
+    return None
+
+
+def validate_semver(version):
+    pattern = r'^v(\d+)\.(\d+)\.(\d+)$'
+    match = re.match(pattern, version)
+    if match:
+        return tuple(map(int, match.groups()))
+    else:
+        return None
+
+
+def compare_versions(input_version, cmake_version):
+    if input_version > cmake_version:
+        print("Input version is greater than CMake version.")
+        exit(1)
+    elif input_version < cmake_version:
+        print("Input version is smaller than CMake version.")
+        exit(1)
+    else:
+        print("Input version is equal to CMake version.")
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Check input version against CMake project version")
+    parser.add_argument("--version", type=str, help="Input version with a 'v' prefix", required=True)
+    args = parser.parse_args()
+
+    cmake_version = get_cmake_version("CMakeLists.txt")
+    if cmake_version is None:
+        print("Failed to retrieve version from CMakeLists.txt.")
+        exit(1)
+    else:
+        input_version = validate_semver(args.version)
+        if input_version is None:
+            print("Invalid input version format. Please provide a version in the format 'vX.Y.Z'")
+            exit(1)
+        else:
+            compare_versions(input_version, cmake_version)
+
+
+