<TBBAS-2530> Cleanup commented yml code

Author: Aliaksandr Adziareika

.github/actions/framework-download/action.yml

@@ -1,12 +1,15 @@
-name: Download openDAQ framework package from S3
-description: "Download a package from S3 and install it depending on OS and architecture"
+name: Download openDAQ framework package
+description: "Download a package from S3 for Linux or Windows"
+
 inputs:
   src-opendaq-framework-dev:
     required: true
+    description: "S3 path to the package"
   dst-opendaq-framework-dev:
     required: false
     default: ${{ runner.temp }}
-  
+    description: "Destination path for downloaded package"
+
   aws_access_key_id:
     required: true
     description: "AWS Access Key ID"
@@ -16,14 +19,6 @@ inputs:
   aws_region:
     required: true
     description: "AWS Region"
-  
-  shell:
-    required: false
-    default: "bash"
-
-  debug:
-    required: false
-    default: false
 
 runs:
   using: composite
@@ -35,17 +30,21 @@ runs:
         aws-secret-access-key: ${{ inputs.aws_secret_access_key }}
         aws-region: ${{ inputs.aws_region }}
 
-    # - name: Enumerate bucket
-    #   shell: ${{ inputs.shell }}
-    #   run: |
-    #     aws s3 ls "s3://${{ inputs.s3_bucket }}" --recursive --human-readable
-    
-    # - name: Enumerate bucket releases main
-    #   shell: ${{ inputs.shell }}
-    #   run: |
-    #     aws s3 ls "s3://${{ inputs.s3_bucket }}/${{ inputs.s3_path }}" --recursive --human-readable
+    - name: Download package from S3 (Linux/macOS)
+      if: runner.os != 'Windows'
+      shell: bash
+      run: |
+        set -e
+        DST="${{ inputs.dst-opendaq-framework-dev }}"
+        SRC="${{ inputs.src-opendaq-framework-dev }}"
+        echo "Downloading $SRC to $DST"
+        aws s3 cp "$SRC" "$DST"
 
-    - name: Download package from S3
-      shell: ${{ inputs.shell }}
+    - name: Download package from S3 (Windows)
+      if: runner.os == 'Windows'
+      shell: pwsh
       run: |
-        aws s3 cp "${{ inputs.src-opendaq-framework-dev }}" "${{ inputs.dst-opendaq-framework-dev }}"
+        $dst = "${{ inputs.dst-opendaq-framework-dev }}"
+        $src = "${{ inputs.src-opendaq-framework-dev }}"
+        Write-Host "Downloading $src to $dst"
+        aws s3 cp "$src" "$dst"

.github/actions/framework-install/action.yml

@@ -1,25 +1,26 @@
 name: Install openDAQ framework package
+
 inputs:
   src-opendaq-framework:
     required: true
 
 runs:
   using: composite
-  
+
   steps:
     - name: Install openDAQ framework package (Windows)
-      if: runner.OS == 'Windows'
-      shell: powershell
-      run: ${{ inputs.src-opendaq-framework}} /S
+      if: runner.os == 'Windows'
+      shell: pwsh
+      run: '"${{ inputs.src-opendaq-framework }}" /S'
 
     - name: Install openDAQ framework package (Linux)
-      if: ${{ runner.OS }} == 'Linux'
+      if: runner.os == 'Linux'
       shell: bash
-      run: sudo dpkg -i ${{ inputs.src-opendaq-framework }}
+      run: sudo dpkg -i "${{ inputs.src-opendaq-framework }}"
 
     - name: Unsupported runner OS
       if: runner.os != 'Windows' && runner.os != 'Linux'
       shell: bash
-      run: 
+      run: |
         echo "Install openDAQ is not supported for ${{ runner.os }}"
         exit 1

.github/actions/framework-latest-release/action.yml

@@ -1,4 +1,4 @@
-name: Determine openDAQ framework latest artefact
+name: Determine latest openDAQ framework artefact
 
 inputs:
   win32-force: 
@@ -8,28 +8,34 @@ inputs:
 outputs:
   version:
     description: "Latest openDAQ release version"
+    value: ${{ steps.determine-latest-package.outputs.version }}
   platform:
     description: "Detected platform"
+    value: ${{ steps.determine-latest-package.outputs.platform }}
   packaging:
     description: "Package type (deb/exe)"
+    value: ${{ steps.determine-latest-package.outputs.packaging }}
   artefact:
     description: "Artefact filename"
-    value: ${{ steps.determine-framework.outputs.artefact }}
+    value: ${{ steps.determine-latest-package.outputs.artefact }}
   uri:
     description: "Full URI to artefact"
-    value: ${{ steps.determine-framework.outputs.uri }}
+    value: ${{ steps.determine-latest-package.outputs.uri }}
   scheme:
     description: "Scheme (s3)"
+    value: ${{ steps.determine-latest-package.outputs.scheme }}
   authority:
     description: "Authority (bucket)"
+    value: ${{ steps.determine-latest-package.outputs.authority }}
   path:
     description: "Path inside bucket"
+    value: ${{ steps.determine-latest-package.outputs.path }}
 
 runs:
   using: composite
   steps:
-    - name: Determine openDAQ package latest release version
-      id: determine-framework
+    - name: Determine latest openDAQ package
+      id: determine-latest-package
       shell: bash
       run: |
         set -e
@@ -44,7 +50,7 @@ runs:
         platform=""
         packaging=""
 
-        if [[ "${{ runner.os }}" == "Linux" ]]; then
+        if [[ "$RUNNER_OS" == "Linux" ]]; then
           arch=$(uname -m)
           if [[ "$arch" == "x86_64" ]]; then
             platform="ubuntu22.04-x86_64"
@@ -56,16 +62,17 @@ runs:
           fi
           packaging="deb"
 
-        elif [[ "${{ runner.os }}" == "Windows" ]]; then
-          if [[ "${{ inputs.win32-force }}" == "true" ]]; then
+        elif [[ "$RUNNER_OS" == "Windows" ]]; then
+          WIN32_FORCE="${{ inputs.win32-force }}"
+          if [[ "$WIN32_FORCE" == "true" ]]; then
             platform="win32"
           else
             platform="win64"
           fi
           packaging="exe"
 
         else
-          echo "::error::Unsupported runner OS ${{ runner.os }}"
+          echo "::error::Unsupported runner OS $RUNNER_OS"
           exit 1
         fi
 

.github/workflows/ci.yml

@@ -7,12 +7,12 @@ on:
       - jira/*
 
 env:
-    GH_TOKEN: ${{ github.token }}
+  GH_TOKEN: ${{ github.token }}
 
 jobs:
-    build-and-test:
-      runs-on: ubuntu-latest
-      steps:
+  build-and-test:
+    runs-on: ubuntu-latest
+    steps:
 
       - name: Checkout simple device module repo
         uses: actions/checkout@v4
@@ -21,7 +21,21 @@ jobs:
         id: opendaq-framework
         uses: ./.github/actions/framework-latest-release
 
-      - name: Donwload openDAQ framework
+      - name: Check openDAQ framework package is detected
+        run: |
+          if [[ -z "${{ steps.opendaq-framework.outputs.uri }}" ]]; then
+            echo "::error::openDAQ framework URI is empty!"
+            exit 1
+          fi
+          if [[ -z "${{ steps.opendaq-framework.outputs.artefact }}" ]]; then
+            echo "::error::openDAQ artefact name is empty!"
+            exit 1
+          fi
+
+      - name: Prepare temporary directory
+        run: mkdir -p ${{ runner.temp }}
+
+      - name: Download openDAQ framework
         uses: ./.github/actions/framework-download
         with:
           src-opendaq-framework-dev: ${{ steps.opendaq-framework.outputs.uri }}
@@ -35,14 +49,13 @@ jobs:
         with:
           src-opendaq-framework: ${{ runner.temp }}/${{ steps.opendaq-framework.outputs.artefact }}
 
-      - name: Configure CMake 
+      - name: Configure simple device module with CMake
         run: cmake -B build/output -S . -G Ninja -DOPENDAQ_ENABLE_TESTS=ON -DCMAKE_BUILD_TYPE=Release
 
-      - name: Build
+      - name: Build simple device module with CMake
         run: cmake --build build/output --target all
 
-      - name: Run tests with GTest report
+      - name: Run simple device module tests via CTest with GTest report
         run: |
           mkdir -p build/reports
-          export GTEST_OUTPUT=xml:$(pwd)/build/reports/gtest-report.xml
-          ctest --test-dir build/output --output-on-failure -V
+          GTEST_OUTPUT=xml:$(pwd)/build/reports/gtest-report.xml ctest --test-dir build/output --output-on-failure -V