Merge pull request #127 from EmixamPP/ci

chore(CI): refactors

Author: EmixamPP

.github/actions/install-opencv.yml

@@ -4,8 +4,12 @@ on:
   workflow_dispatch:
   workflow_call:
 
+env: 
+  OPENCV_VERSION: "4.8.0"
+
 jobs:
   build:
+    name: Building
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -18,12 +22,37 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt-get update -y
-          sudo apt-get install -y python3-setuptools python3-wheel ninja-build g++ pkg-config libgtk-3-dev
+          sudo apt-get install -y python3-setuptools python3-wheel ninja-build g++ pkg-config libgtk-3-dev zlib1g-dev cmake
           python -m pip install --upgrade pip
           python -m pip install meson
       
+      - name: Cache OpenCV
+        id: cache
+        uses: actions/cache@v3
+        with:
+          path: opencv
+          key: opencv-${{ env.OPENCV_VERSION }}
+
+      - name: Build tiny static OpenCV
+        if: ${{ steps.cache.outputs.cache-hit != 'true' }}
+        run: |
+          sudo apt-get install -y curl
+          mkdir -p opencv/build
+          curl -L https://github.com/opencv/opencv/archive/refs/tags/${{ env.OPENCV_VERSION }}.tar.gz | tar -xz -C opencv
+          cmake -B opencv/build -S opencv/opencv-${{ env.OPENCV_VERSION }} -GNinja \
+              -DBUILD_SHARED_LIBS=OFF -DOPENCV_GENERATE_PKGCONFIG=YES \
+              -DBUILD_LIST=videoio,highgui -WITH_V4L=ON -DWITH_GTK=ON \
+              -DWITH_JPEG=OFF -DWITH_PNG=OFF -DWITH_TIFF=OFF -DWITH_WEBP=OFF -DWITH_OPENJPEG=OFF -DWITH_JASPER=OFF -DWITH_OPENEXR=OFF -DWITH_IMGCODEC_HDR=OFF -DWITH_IMGCODEC_SUNRASTER=OFF -DWITH_IMGCODEC_PXM=OFF -DWITH_IMGCODEC_PFM=OFF \
+              -DWITH_FFMPEG=FALSE -DWITH_GSTREAMER=OFF -DWITH_1394=OFF -DDVIDEOIO_ENABLE_PLUGINS=OFF -DWITH_ANDROID_MEDIANDK=OFF \
+              -DHIGHGUI_ENABLE_PLUGINS=OFF -DWITH_VTK=OFF \
+              -DWITH_PROTOBUF=OFF -DOPENCV_DNN_OPENCL=OFF \
+              -DWITH_VA_INTEL=OFF -DWITH_OPENCL=OFF -DWITH_OPENCL_SVM=OFF -DWITH_OPENCLAMDFFT=OFF -DWITH_OPENCLAMDBLAS=OFF -DWITH_OPENCL_D3D11_NV=OFF \
+              -DWITH_IPP=OFF -DWITH_CAROTENE=OFF -DWITH_CPUFEATURES=OFF -DWITH_EIGEN=OFF -DWITH_OPENVX=OFF -DWITH_DIRECTX=OFF -DWITH_VA=OFF -DWITH_LAPACK=OFF -DWITH_QUIRC=OFF
+          ninja -C opencv/build
+          
       - name: Install OpenCV
-        uses: ./.github/actions/install-opencv.yml
+        run: |
+          sudo ninja install -C opencv/build
 
       - name: Setup build
         run: |
@@ -37,8 +66,7 @@ jobs:
       - name: Create tarball - Systemd
         run: |
           DESTDIR=install_dir_systemd meson install -C build
-          sudo chown -R root:root build/install_dir_systemd
-          tar -czvf build/linux-enable-ir-emitter.systemd.x86-64.tar.gz -C build/install_dir .
+          tar -czvf build/linux-enable-ir-emitter.systemd.x86-64.tar.gz -C build/install_dir_systemd .
       
       - name: Upload tarball - Systemd
         uses: actions/upload-artifact@v3
@@ -54,8 +82,7 @@ jobs:
       - name: Create tarball - OpenRC
         run: |
           DESTDIR=install_dir_openrc meson install -C build
-          sudo chown -R root:root build/install_dir_openrc
-          tar -czvf build/linux-enable-ir-emitter.openrc.x86-64.tar.gz -C build/install_dir .
+          tar -czvf build/linux-enable-ir-emitter.openrc.x86-64.tar.gz -C build/install_dir_openrc .
       
       - name: Upload tarball - OpenRC
         uses: actions/upload-artifact@v3

.github/workflows/arm.yml

@@ -6,21 +6,20 @@ on:
 
 jobs:
   lint:
+    name: C++ linting
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
 
       - name: Install dependencies
         run: |
-          sudo apt-get install -y python3-setuptools python3-wheel ninja-build g++ clang-tidy libgtk-3-dev libopencv-video-dev libopencv-video-dev
+          sudo apt-get install -y python3-setuptools python3-wheel ninja-build g++ pkg-config clang-tidy libgtk-3-dev libopencv-dev
           python -m pip install --upgrade pip
           python -m pip install meson
 
       - name: Setup
         run: |
-          meson setup build
-          meson configure build -Dwerror=false
-          meson compile -C build
+          meson setup build 
 
       - name: Lint
         run: |

.github/workflows/build.yml

@@ -19,11 +19,9 @@ jobs:
             VERSION=$(gh api "/repos/$OWNER/$REPO/releases/latest" --jq ".tag_name")
             echo "VERSION=$VERSION" >> "$GITHUB_ENV"
 
-      - name: Modify files if new version
+      - name: Modify file if new version
         run: |
-            sed -E -i "s@(OPENCV_VERSION:\s+\")([0-9]+\.[0-9]+\.[0-9]+)(\")@\1$VERSION\3@" .github/actions/install-opencv.yml
-            sed -E -i "s@(OPENCV_VERSION:\s+\")([0-9]+\.[0-9]+\.[0-9]+)(\")@\1$VERSION\3@" .github/workflows/arm.yml
-            sed -E -i "s@(curl https://raw.githubusercontent.com/EmixamPP/opencv-tiny/main/build.sh | bash -s )[0-9]+\.[0-9]+\.[0-9]+(.*)@\1$VERSION\2@" README.md
+            sed -E -i "s@(OPENCV_VERSION:\s+\")([0-9]+\.[0-9]+\.[0-9]+)(\")@\1$VERSION\3@" .github/workflows/build.yml
             
       - name: Create PR if new version
         uses: peter-evans/create-pull-request@v5

.github/workflows/cpp-lint.yml

@@ -5,47 +5,42 @@ on:
 
 jobs:
   py-lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Python linting
-        uses: ./.github/workflows/py-lint.yml
+    uses: ./.github/workflows/py-lint.yml
 
   cpp-lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: C++ linting
-        uses: ./.github/workflows/cpp-lint.yml
+    uses: ./.github/workflows/cpp-lint.yml
 
   build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Build
-        uses: ./.github/workflows/build.yml
+    uses: ./.github/workflows/build.yml
 
   comment:
+    name: Bot comment
     needs: 
       - py-lint
       - cpp-lint
       - build
     runs-on: ubuntu-latest
+    if: always()
     steps:
-      - name: Create/Update comment
-        uses: thollander/actions-comment-pull-request@v2
+      - uses: thollander/actions-comment-pull-request@v2
         with:
           comment_tag: bot_comment
           mode: recreate
           GITHUB_TOKEN: ${{ github.token }}
           message: |
-            # Commit ${{ github.event.pull_request.head.sha }}
+            ## :arrow_right: Commit ${{ github.event.pull_request.head.sha }}
+
+            ## :clipboard: [Logs](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})
 
-            ## CI results:
+            ## :mag: Linting results:
             ${{ needs.py-lint.result == 'success' && ':heavy_check_mark:' || ':x:' }} Python Linting
 
             ${{ needs.cpp-lint.result == 'success' && ':heavy_check_mark:' || ':x:' }} C++ Linting
 
+            ## :hammer_and_wrench: Building result:
             ${{ needs.build.result == 'success' && ':heavy_check_mark:' || ':x:' }} Building
 
-            ## Builds:
-            If the building step was successfull, you can download the tarball you want in the artifacts section [here](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}).
+            ## :package: Tarballs:
+            If the building step was successfull, you can download the appropriate tarball in the artifacts section [here](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}).
 
             Unzip and then execute `sudo tar -C / --no-same-owner -h -xzf linux-enable-ir-emitter*.tar.gz`. 

.github/workflows/depend-opencv.yml

@@ -5,7 +5,8 @@ on:
   workflow_call:
 
 jobs:
-  py-lint:
+  lint:
+    name: Python linting
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.github/workflows/pr.yml

@@ -1,14 +1,12 @@
 # Python
-__pycache__
-env
+__pycache__/
+env/
 
 # Meson
-build
+build/
 
 # OpenCV
-opencv*
-!sources/camera/opencv.hpp
-zlib*
+opencv/
 
 # Others
-.vscode
+.vscode/

.github/workflows/py-lint.yml

@@ -5,13 +5,14 @@ Provides support for infrared cameras that are not directly enabled out-of-the b
 `linux-enable-ir-emitter` can automatically generate a lightweight driver (located in user space) for almost any (UVC) infrared emitter.
 
 ## Installation
-Directly refer to the manual buid [section](#manual-build) if your boot service manager is not Systemd but OpenRC. Stay here if you don't know. We support ARM architectures, just download the `aarch64` variant.
- 
-Download the latest `linux-enable-ir-emitter-x.x.x.x86-64.tar.gz` [here](https://github.com/EmixamPP/linux-enable-ir-emitter/releases/latest), then execute:
+Download the latest `linux-enable-ir-emitter-x.x.x.systemd.x86-64.tar.gz` [here](https://github.com/EmixamPP/linux-enable-ir-emitter/releases/latest), then execute:
 ```
-sudo tar -C / -h -xzf linux-enable-ir-emitter-*.tar.gz
+sudo tar -C / --no-same-owner -h -xzf linux-enable-ir-emitter*.tar.gz
 ```
 
+We also support OpenRC, just download the `.openrc` variant.
+
+### Uninstallation
 It can be uninstalled by executing (remove the last line to keep the emitter configuration):
 ```
 sudo rm -rf /usr/lib64/linux-enable-ir-emitter \
@@ -46,30 +47,22 @@ The software supports the configuration of multiple devices, execute the configu
 ## Manual build
 See [docs](docs/requirements.md) for specification concerning build requirements.
 
-Clone the git:
+Setup build:
 ```
 git clone https://github.com/EmixamPP/linux-enable-ir-emitter.git
 cd linux-enable-ir-emitter
-```
-
-Build my minimal version of OpenCV that will be statically linked. This is not required, you can use the shared opencv library of your distro. But it is recommanded in order to do not have issues after distro updates:
-```
-curl https://raw.githubusercontent.com/EmixamPP/opencv-tiny/main/build.sh | bash -s 4.8.0 "${PWD}/opencv-tiny"
-```
-
-Setup build (remove `--pkg-config-path=...` if you skipped the previous step):
-```
-meson setup build --pkg-config-path=$(find opencv-tiny -name pkgconfig | tr '\n' ':')
+meson setup build
 ```
 
 Only if you do not have Systemd but OpenRC:
 ```
 meson configure build -Dboot_service=openrc
 ```
 
-Build and install linux-enable-ir-emitter:
+Compile and install:
 ```
-sudo meson install -C build
+meson compile -C build
+meson install -C build
 ```
 
-You can uninstall the software by executing `sudo ninja uninstall -C build`. 
+You can uninstall the tool by executing `sudo ninja uninstall -C build`. 

.gitignore

@@ -1,4 +1,4 @@
-### Please, first, ensure that you have the last version. Compare the [latest release](https://github.com/EmixamPP/linux-enable-ir-emitter/releases/latest) with `linux-enable-ir-emitter -V`
+## Please, first, ensure that you have the last version. Compare the [latest release](https://github.com/EmixamPP/linux-enable-ir-emitter/releases/latest) with `linux-enable-ir-emitter -V`
 
 ## The configuration has failed 
 If you had the message `INFO: Please shut down your computer, then boot and retry.`, please follow these instructions first:
@@ -13,11 +13,12 @@ Otherwise, open an issue using the "Configuration has failed" template.
 ## The emitter does not work after successful configuration or after update.
 1. If you use Howdy, be sure it uses the infrared camera configured; the path is printed after the message `INFO: Configuring the camera:`.
 2. Execute `sudo linux-enable-ir-emitter boot enable`.
-3. If none of the previous fix your problem, open an issue using the "Emitter does not work after successful configuration" template.
+3. Open an issue using the "Emitter does not work after successful configuration" template.
 
 ## Error with the systemd/openrc or udev boot service
 1. Ensure you have `systemd` or `openrc` (and the related version installed)
 2. Open an issue using the "Emitter does not work after successful configuration" template.
 
 ## Other bugs
-Open an issue using the "Bug report" template.
+1. If the problem seems to be a library problem, first try the binary I provide by following the [readme](../README.md) instructions. 
+2. Open an issue using the "Bug report" template.