Merge pull request #186 from EmixamPP/chore/ci/minsize

chore(ci): minsize

.clang-format

@@ -0,0 +1,2 @@
+BasedOnStyle: Google
+ColumnLimit: 100

.clang-tidy

@@ -1,27 +1,19 @@
 ---
 Checks: '
--clang-diagnostic-pragma-system-header-outside-header,
-readability*,
--readability-identifier-length,
--readability-braces-around-statements,
--readability-magic-numbers,
--readability-named-parameter,
--readability-function-cognitive-complexity,
--readability-use-anyofallof,
--readability-convert-member-functions-to-static,
--readability-else-after-return,
+bugprone*,
+-bugprone-easily-swappable-parameters,
+-bugprone-empty-catch,
 cppcoreguidelines*,
+-cppcoreguidelines-avoid-const-or-ref-data-members,
+-cppcoreguidelines-avoid-non-const-global-variables,
 -cppcoreguidelines-init-variables,
--cppcoreguidelines-avoid-magic-numbers,
--cppcoreguidelines-pro-type-vararg,
 -cppcoreguidelines-pro-type-const-cast,
+-cppcoreguidelines-pro-type-vararg,
 -cppcoreguidelines-pro-type-member-init,
--cppcoreguidelines-avoid-const-or-ref-data-members,
--cppcoreguidelines-pro-bounds-array-to-pointer-decay,
--cppcoreguidelines-avoid-c-arrays,
--cppcoreguidelines-pro-bounds-pointer-arithmetic,
--cppcoreguidelines-non-private-member-variables-in-classes,
--cppcoreguidelines-avoid-non-const-global-variables,
--cppcoreguidelines-avoid-do-while
+performance*,
+-performance-avoid-endl,
+readability*,
+-readability-braces-around-statements,
+-readability-identifier-length,
 '
 WarningsAsErrors: '*'

.github/workflows/build.yml

@@ -19,11 +19,6 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Load dependencies versions
-        uses: cardinalby/export-env-action@v2
-        with:
-          envFile: '.github/workflows/deps/version.env'
-
       - name: Install build dependencies
         run: |
           sudo apt-get update
@@ -35,23 +30,30 @@ jobs:
         uses: actions/cache@v4
         with:
           path: .github/workflows/deps/install_dir
-          key: ${{ env.OPENCV_GIT_TAG }}-${{ env.YAML_GIT_TAG }}-${{ env.ARGPARSE_GIT_TAG }}-${{ env.SPDLOG_GIT_TAG }}
+          key: ${{ hashFiles('.github/workflows/deps/CMakeLists.txt') }}
 
       - name: Build lib dependencis
         if: ${{ steps.deps-cache.outputs.cache-hit != 'true' }}
         run: |
           cd .github/workflows/deps
-          cmake . -B build -GNinja \
-            -DOPENCV_GIT_TAG=${{ env.OPENCV_GIT_TAG }} \
-            -DYAML_GIT_TAG=${{ env.YAML_GIT_TAG }} \
-            -DARGPARSE_GIT_TAG=${{ env.ARGPARSE_GIT_TAG }} \
-            -DSPDLOG_GIT_TAG=${{ env.SPDLOG_GIT_TAG }}
+          cmake . -B build -GNinja
           ninja -C build
-          cd -
 
       - name: Setup build
         run: |
-          meson setup build --buildtype ${{ inputs.buildtype }} --libdir=lib --prefer-static --pkg-config-path=$(find .github -name "pkgconfig")
+          meson setup build --libdir=lib --prefer-static --pkg-config-path=$(find .github -name "pkgconfig")
+          case "${{ inputs.buildtype }}" in
+            "release")
+              meson configure build --optimization=s --strip
+              ;;
+            "debug")
+              meson configure build --buildtype=debug
+              ;;
+            *)
+              echo "Build type ${{ inputs.buildtype }} not supported"
+              exit 1
+              ;;
+          esac
 
       - name: Compile
         run: |

.github/workflows/clang-format.yml

@@ -0,0 +1,32 @@
+name: "clang-format"
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  clang-format:
+    name: clang-format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y python3-setuptools python3-wheel ninja-build g++ pkg-config libgtk-3-dev
+          python -m pip install meson
+
+      - name: Cache lib dependencies
+        uses: actions/cache@v4
+        with:
+          path: .github/workflows/deps/install_dir
+          key: ${{ hashFiles('.github/workflows/deps/CMakeLists.txt') }}
+
+      - name: Setup
+        run: |
+          meson setup build --prefer-static --pkg-config-path=$(find .github -name "pkgconfig")
+
+      - name: Check
+        run: |
+          ninja clang-format -C build

.github/workflows/cpp-lint.yml → .github/workflows/clang-tidy.yml

@@ -1,21 +1,16 @@
-name: "C++ Lint"
+name: "clang-tidy"
 
 on:
   workflow_dispatch:
   workflow_call:
 
 jobs:
-  lint:
-    name: C++ linting
+  clang-tidy:
+    name: clang-tidy
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
-      - name: Load dependencies versions
-        uses: cardinalby/export-env-action@v2
-        with:
-          envFile: '.github/workflows/deps/version.env'
-
       - name: Install dependencies
         run: |
           sudo apt-get update
@@ -26,13 +21,12 @@ jobs:
         uses: actions/cache@v4
         with:
           path: .github/workflows/deps/install_dir
-          key: ${{ env.OPENCV_GIT_TAG }}-${{ env.YAML_GIT_TAG }}-${{ env.ARGPARSE_GIT_TAG }}
-          fail-on-cache-miss: true
+          key: ${{ hashFiles('.github/workflows/deps/CMakeLists.txt') }}
 
       - name: Setup
         run: |
           meson setup build --prefer-static --pkg-config-path=$(find .github -name "pkgconfig")
 
-      - name: Lint
+      - name: Check
         run: |
           ninja clang-tidy -C build

.github/workflows/depend-argparse.yml

@@ -21,8 +21,8 @@ jobs:
 
       - name: Modify file if new version
         run: |
-            sed -E -i "s@(ARGPARSE_GIT_TAG=\s+\")(v[0-9]+\.[0-9]+\.[0-9]+)(\")@\1$VERSION\3@" .github/workflows/deps/version.env
-            
+            sed -i 's/\(set(ARGPARSE_GIT_TAG "\)[^"]*\(".*\)/\1${{ env.VERSION }}\2/' .github/workflows/deps/CMakeLists.txt
+
       - name: Create PR if new version
         uses: peter-evans/create-pull-request@v6
         with:

.github/workflows/depend-opencv.yml

@@ -21,8 +21,8 @@ jobs:
 
       - name: Modify file if new version
         run: |
-            sed -E -i "s@(OPENCV_GIT_TAG=\s+\")([0-9]+\.[0-9]+\.[0-9]+)(\")@\1$VERSION\3@" .github/workflows/deps/version.env
-            
+            sed -i 's/\(set(OPENCV_GIT_TAG "\)[^"]*\(".*\)/\1${{ env.VERSION }}\2/' .github/workflows/deps/CMakeLists.txt
+
       - name: Create PR if new version
         uses: peter-evans/create-pull-request@v6
         with:

.github/workflows/depend-spdlog.yml

@@ -21,8 +21,8 @@ jobs:
 
       - name: Modify file if new version
         run: |
-            sed -E -i "s@(SPDLOG_GIT_TAG=\s+\")(v[0-9]+\.[0-9]+\.[0-9]+)(\")@\1$VERSION\3@" .github/workflows/deps/version.env
-            
+            sed -i 's/\(set(SPDLOG_GIT_TAG "\)[^"]*\(".*\)/\1${{ env.VERSION }}\2/' .github/workflows/deps/CMakeLists.txt
+
       - name: Create PR if new version
         uses: peter-evans/create-pull-request@v6
         with:

.github/workflows/depend-yaml.yml

@@ -21,8 +21,8 @@ jobs:
 
       - name: Modify file if new version
         run: |
-            sed -E -i "s@(YAML_GIT_TAG=\s+\")([0-9]+\.[0-9]+\.[0-9]+)(\")@\1$VERSION\3@" .github/workflows/deps/version.env
-            
+            sed -i 's/\(set(YAML_GIT_TAG "\)[^"]*\(".*\)/\1${{ env.VERSION }}\2/' .github/workflows/deps/CMakeLists.txt
+
       - name: Create PR if new version
         uses: peter-evans/create-pull-request@v6
         with:

.github/workflows/deps/CMakeLists.txt

@@ -5,10 +5,10 @@ if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
     set(CMAKE_INSTALL_PREFIX "${PROJECT_SOURCE_DIR}/install_dir" CACHE PATH "Default install prefix" FORCE)
 endif()
 
-option(OPENCV_GIT_TAG "Tag or branch used to checkout when cloning opencv" "master")
-option(YAML_GIT_TAG "Tag or branch used to checkout when cloning yaml-cpp" "master")
-option(ARGPARSE_GIT_TAG "Tag or branch used to checkout when cloning argparse" "master")
-option(SPDLOG_GIT_TAG "Tag or branch used to checkout when cloning argparse" "v1.x")
+set(OPENCV_GIT_TAG "4.9.0" CACHE STRING "Tag or branch used to checkout when cloning opencv")
+set(YAML_GIT_TAG "0.8.0" CACHE STRING "Tag or branch used to checkout when cloning yaml-cpp")
+set(ARGPARSE_GIT_TAG "v3.1" CACHE STRING "Tag or branch used to checkout when cloning argparse")
+set(SPDLOG_GIT_TAG "v1.14.1" CACHE STRING "Tag or branch used to checkout when cloning argparse")
 
 include(ExternalProject)
 

.github/workflows/pr.yml

@@ -9,16 +9,22 @@ jobs:
     with:
       buildtype: debug
 
-  cpp-lint:
+  clang-tidy:
     needs:
       - build
-    uses: ./.github/workflows/cpp-lint.yml
+    uses: ./.github/workflows/clang-tidy.yml
+
+  clang-format:
+    needs:
+      - build
+    uses: ./.github/workflows/clang-format.yml
 
   comment:
     name: Bot comment
     needs:
       - build
-      - cpp-lint
+      - clang-tidy
+      - clang-format
     runs-on: ubuntu-latest
     if: always()
     steps:
@@ -31,10 +37,12 @@ jobs:
 
             ## :clipboard: [Logs](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})
 
-            ## :mag: Linting results: ${{ (needs.cpp-lint.result == 'success' && ':white_check_mark:') || (needs.cpp-lint.result == 'skipped' && ':no_entry_sign:') || ':x:' }}
-
             ## :hammer_and_wrench: Building result: ${{ needs.build.result == 'success' && ':white_check_mark:' || ':x:' }}
 
+            ## :mag: clang-tidy results: ${{ (needs.clang-tidy.result == 'success' && ':white_check_mark:') || (needs.clang-tidy.result == 'skipped' && ':no_entry_sign:') || ':x:' }}
+
+            ## :writing_hand: clang-format results: ${{ (needs.clang-format.result == 'success' && ':white_check_mark:') || (needs.clang-format.result == 'skipped' && ':no_entry_sign:') || ':x:' }}
+
             ## :package: Artifacts:
             If the building step was successfull:
             1. Download the tarball in the artifacts section [here](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}).
@@ -43,4 +51,4 @@ jobs:
             4. [Execute the install instructions](README.md#installation)
 
             During the execution the tool raises an exception?\
-            Please send us the gdb backtrace: `sudo gdb --ex run --args linux-enable-ir-emitter <your command args>`, once the crash arrives, type "bt" to show the error trace ("q" to exit).
+            Please send us the gdb backtrace: `sudo gdb --ex run --args linux-enable-ir-emitter <your command args>`, once the crash arrives, type `bt` to show the error trace (`q` to exit).

CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing to linux-enable-ir-emitter
+Thank you for considering contributing to our project! We appreciate your interest and effort in improving linux-enable-ir-emitter. Please follow the guidelines below to ensure a smooth contribution process.
+
+## Reporting Issues
+Before opening a new issue, please check the [docs](docs/README.md) first in order to either find answer to your question or to use the right template.
+
+## Contributing Code
+To be sure that the modifications you made to the code will pass the CI during the PR, please perform the following steps:
+1. Compile locally the dependencies:
+    ```
+    cd .github/workflows/deps && cmake -GNinja -B build && ninja -C build && cd -
+    ```
+2. Setup the build:
+    ```
+    meson setup build --buildtype=debug --libdir=lib --prefer-static --pkg-config-path=$(find . -name "pkgconfig")`
+    ```
+3. Compile:
+   ```
+   meson compile −C build
+   ```
+   your new version of `linux-enable-ir-emitter` is located in `build/src/`
+4. Format the files:
+   ```
+   ninja clang-format -C build
+   ```
+5. Ensure clang-tidy pass:
+   ```
+   ninja clang-tidy -C build
+   ```
+6. Commit, push and please describe enough what you did in your PR description