Testing Github Workflow

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main, dev]
+
+jobs:
+  commitlint:
+    name: Validate Commits
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - run: npm install --save-dev @commitlint/cli @commitlint/config-conventional
+
+      - run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }}
+
+  build:
+    name: Build Firmware
+    runs-on: ubuntu-latest
+    container:
+      image: espressif/idf:v5.5.1
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Build
+        run: bash tools/build.sh
+        shell: bash

.github/workflows/release.yml

@@ -0,0 +1,86 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  version:
+    name: Semantic Release
+    runs-on: ubuntu-latest
+    outputs:
+      new_release: ${{ steps.semrel.outputs.new_release }}
+      version: ${{ steps.semrel.outputs.version }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install dependencies
+        run: |
+          npm install \
+            semantic-release \
+            conventional-changelog-conventionalcommits \
+            @semantic-release/commit-analyzer \
+            @semantic-release/release-notes-generator \
+            @semantic-release/changelog \
+            @semantic-release/exec \
+            @semantic-release/git \
+            @semantic-release/github
+
+      - name: Run semantic-release
+        id: semrel
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          OUTPUT=$(npx semantic-release 2>&1) || true
+          echo "$OUTPUT"
+          VERSION=$(echo "$OUTPUT" | grep -oP 'Published release \K[0-9]+\.[0-9]+\.[0-9]+' || echo "")
+          if [ -n "$VERSION" ]; then
+            echo "new_release=true" >> $GITHUB_OUTPUT
+            echo "version=$VERSION" >> $GITHUB_OUTPUT
+          else
+            echo "new_release=false" >> $GITHUB_OUTPUT
+          fi
+
+  build:
+    name: Build & Upload
+    needs: version
+    if: needs.version.outputs.new_release == 'true'
+    runs-on: ubuntu-latest
+    container:
+      image: espressif/idf:v5.5.1
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 0
+          submodules: recursive
+
+      - name: Pull latest (includes version commit)
+        run: git pull origin main
+
+      - name: Build
+        run: bash tools/build.sh
+        shell: bash
+
+      - name: Upload binary to Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION: ${{ needs.version.outputs.version }}
+        run: |
+          cp firmware_p4/build/TentacleOS_P4.bin "TentacleOS_v${VERSION}.bin"
+          gh release upload "v${VERSION}" \
+            "TentacleOS_v${VERSION}.bin" \
+            --clobber

.gitignore

@@ -4,6 +4,9 @@
 /lvgl-env/
 **/lvgl-env/
 /temp/
+temp/
+temp
+**/temp/**
 **/temp/
 LVGLImage.py
 
@@ -533,7 +536,6 @@ object_script.*.Debug
 moc_*.cpp
 moc_*.h
 qrc_*.cpp
-ui_*.h
 *.qmlc
 *.jsc
 Makefile*

.releaserc.json

@@ -0,0 +1,30 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    ["@semantic-release/commit-analyzer", {
+      "preset": "conventionalcommits",
+      "releaseRules": [
+        { "type": "feat", "release": "minor" },
+        { "type": "fix", "release": "patch" },
+        { "type": "perf", "release": "patch" },
+        { "breaking": true, "release": "major" }
+      ]
+    }],
+    "@semantic-release/release-notes-generator",
+    ["@semantic-release/changelog", {
+      "changelogFile": "CHANGELOG.md"
+    }],
+    ["@semantic-release/exec", {
+      "prepareCmd": "sed -i 's/\"version\": *\"[^\"]*\"/\"version\": \"${nextRelease.version}\"/' firmware_p4/assets/config/OTA/firmware.json firmware_c5/assets/config/OTA/firmware.json"
+    }],
+    ["@semantic-release/git", {
+      "assets": [
+        "CHANGELOG.md",
+        "firmware_p4/assets/config/OTA/firmware.json",
+        "firmware_c5/assets/config/OTA/firmware.json"
+      ],
+      "message": "chore(release): v${nextRelease.version}"
+    }],
+    "@semantic-release/github"
+  ]
+}

CONTRIBUTING.md

@@ -74,13 +74,54 @@ We follow the [ESP-IDF Style Guide](https://docs.espressif.com/projects/esp-idf/
 ---
 
 ### Commit Conventions
-We use [Conventional Commits](https://www.conventionalcommits.org/). This helps in generating changelogs and understanding the history.
+We use [Conventional Commits](https://www.conventionalcommits.org/). This is **enforced by a git hook** — commits that don't follow the format will be rejected.
 
 Format: `<type>(<scope>): <description>`
 
-Common types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`.
+| Type | Description | Version Impact |
+|---|---|---|
+| `feat` | New feature | Minor bump (0.**X**.0) |
+| `fix` | Bug fix | Patch bump (0.0.**X**) |
+| `perf` | Performance improvement | Patch bump (0.0.**X**) |
+| `docs` | Documentation only | No bump |
+| `style` | Code style (formatting, etc.) | No bump |
+| `refactor` | Code refactoring | No bump |
+| `test` | Adding or updating tests | No bump |
+| `chore` | Maintenance tasks | No bump |
+| `ci` | CI/CD changes | No bump |
+| `build` | Build system changes | No bump |
+| `revert` | Reverting a previous commit | No bump |
+
+**Breaking changes** (major version bump) are indicated by adding `!` before the colon:
+```
+feat(spi)!: redesigned bridge protocol
+fix!: changed public API return types
+```
+
+Examples:
+```
+feat(subghz): add waterfall visualization
+fix(spi): corrected timeout on bridge init
+feat(bt)!: redesigned BLE protocol
+chore: cleanup unused imports
+refactor(ota): simplified update flow
+```
+
+### Automatic Versioning
+This project uses **Semantic Versioning** with fully automated version bumps via [semantic-release](https://github.com/semantic-release/semantic-release).
+
+- Versioning is handled entirely by **GitHub Actions** — contributors do not need to manage versions manually.
+- When a PR is merged into `main`, the CI pipeline analyzes commit messages, determines the version bump, creates a git tag, generates a changelog, and publishes a GitHub Release with the firmware binaries.
+- Just write your commits following the Conventional Commits format and the rest is automatic.
+
+### Git Hooks Setup
+After cloning the repository, run the setup script to install the required git hooks:
+
+```bash
+./tools/setup.sh
+```
 
-Example: `feat(subghz): add waterfall visualization`
+This installs the `commit-msg` hook that validates your commit messages follow the Conventional Commits format. **Without this, your commits may be rejected during code review.**
 
 ---
 

commitlint.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [2, 'always', [
+      'feat', 'fix', 'docs', 'style', 'refactor',
+      'perf', 'test', 'chore', 'ci', 'build', 'revert',
+      'delete', 'deleted', 'remove', 'removed'
+    ]],
+    'scope-case': [0],
+    'subject-case': [0],
+  },
+};

firmware_c5/CMakeLists.txt

@@ -9,7 +9,7 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
-project(highboy)
+project(TentacleOS_C5)
 
 if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows")
     # Windows Detection

firmware_c5/assets/config/OTA/firmware.json

@@ -1,42 +1,6 @@
 {
-  "system_hardware": "HighBoy_v1",
-  "ota_repository_url": "https://repository.highboy.com.br/firmware/system/update.json",
-  "changelog": "vazio ate agora",
-  "components": {
-    "master_mcu": {
-      "chip": "ESP32-S3",
-      "version": "1.0.0",
-      "status": "active"
-    },
-    "slave_mcu": {
-      "chip": "ESP32-C5",
-      "version": "1.0.0",
-      "status": "active"
-    }
-  }
-}
-
-update.json (its be available in web server, saving it here temporary).
-{
-  "release_tag": "release_2024_01_update", github actions
-  "critical": true,
-  "changelog": "Update crítico do driver de rádio no C5 e melhorias de UI no S3.",
-  "packages": [
-    {
-      "component": "master_mcu",
-      "version": "1.0.1",
-      "url": "https://repository.highboy.com.br/firmware/esp32-s3/fw_s3_1.0.1.bin",
-      "size": 1452032,
-      "md5": "5eb63bbbe01eeed093cb22bb8f5acdc3",
-      "action": "self_update"
-    },
-    {
-      "component": "slave_mcu",
-      "version": "1.0.2",
-      "url": "https://repository.highboy.com.br/firmware/esp32-c5/fw_c5_1.0.2.bin",
-      "size": 524288,
-      "md5": "a1b2c3d4e5f6as12da123f12r6",
-      "action": "flash_via_peripheral"
-    }
-  ]
+  "system_hardware": "HighBoy",
+  "version": "0.1.0",
+  "ota_repository_url": "https://repo.highboy.com.br/firmware/system/update.json",
+  "changelog": ""
 }