Firmware, GitHub, Continuous Integration

[ForrestErickson]

Is your feature request related to a problem? Please describe.
_A clear and concise description of what the problem is.
Ex. I'm always frustrated when we do not have a clear firmware release path an manual version control.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Learn and implement to integrate Continuous Integration GitHub practices.

[ForrestErickson]

From an AI on "continuous integration on github of esp32 projects on PlatformIO"

Continuous Integration (CI) for ESP32 projects on GitHub is primarily achieved using GitHub Actions in combination with the PlatformIO Core CLI. This allows you to automatically build, test, and package firmware every time code is pushed to your repository. [1, 2, 3]
Setting Up the CI Workflow
To implement CI, you must create a YAML configuration file (e.g., ) in your repository. [1, 4]

1. Basic Build Workflow A standard workflow for an ESP32 project typically follows these steps:

• Checkout Code: Uses to pull your code into the virtual runner.
• Setup Python: PlatformIO requires Python (usually version 3.x).
• Install PlatformIO: Use to install the core CLI.
• Run Build: Execute to compile all environments defined in your file. [1, 2, 4, 5, 6]

2. Specialized Commands • : Best for standard projects where you want to build specific environments defined in your configuration.
   • : Ideal for testing libraries or single-file examples without a full project structure. It allows you to specify boards and libraries via command-line arguments.
   • : Used if you have written Unit Tests
   in the folder to validate logic on the runner (host-side) or a remote device.

Advanced CI Features

• Matrix Builds: You can test your ESP32 code across multiple boards (e.g., , ) simultaneously by defining a strategy matrix in your YAML file.
• Artifact Storage: You can configure the workflow to upload the compiled firmware files as GitHub Actions Artifacts
, making them available for download after a successful build.
• Private Repositories: If your project uses private libraries, you must provide a GitHub Personal Access Token (PAT) as a secret to allow PlatformIO to fetch them during the build process. [1, 10, 11, 12]

Common Issues & Solutions

• Bad Binaries: Firmware built in CI might occasionally fail to boot due to environment differences. Ensure your PlatformIO Registry packages
and framework versions are pinned in for consistency.
• Newer ESP32 Chips: Support for very recent chips (like ESP32-P4 or C6) may lag in official stable releases. You may need to use development platforms or third-party forks in your CI configuration.
• Caching: To speed up builds, use to store the directory (where platforms and toolchains are kept) between workflow runs. [1, 13, 14, 15, 16]

AI responses may include mistakes.

[1] https://docs.platformio.org/en/stable/integration/ci/github-actions.html
[2] https://rbklabs.in/ci-cd-pipeline-for-esp32/index.html
[3] https://www.smartlab.at/an-automated-ci-cd-pipeline-to-build-and-release-your-esp32-firmware-with-github-actions/
[4] https://docs.github.com/en/actions/get-started/continuous-integration
[5] https://docs.platformio.org/en/latest/integration/ci/index.html
[6] https://www.reddit.com/r/esp32/comments/icin4o/github_action_for_continuous_integration/
[7] https://piolabs.com/blog/insights/cicd-testing-coverage-versioning.html
[8] https://community.platformio.org/t/library-ci-with-github-actions/35027
[9] https://github.com/espressif/esp32-arduino-lib-builder
[10] https://community.platformio.org/t/github-actions-using-a-private-repository-in-platformio-library-manager/25269
[11] https://community.platformio.org/t/seting-up-a-cicd-pipeline-in-github/31975
[12] https://community.platformio.org/t/building-for-2-targets-in-same-project-with-one-github-repo/26674
[13] https://community.platformio.org/t/github-workflow-builds-not-working/32750
[14] https://community.platformio.org/t/esp32-framework-library-updates/36966
[15] https://community.platformio.org/t/use-of-arduino-esp32-in-platformio/45382
[16] https://community.platformio.org/t/greetings-with-problems-on-how-to-set-up-the-development-environment-for-esp32-p4-using-platformio-i-would-like-to-seek-your-guidance-or-suggestions-thank-you/46966

[nk25719]

Review pull request, merge into main, change the firmware version Patch, later we do a release and increment firmware version Minor for new, backward-compatible functionality

Reviewing PR #476 (Pulls the latest committed tag to insert into the compiler buffer)