Automated firmware management

[cachamber]

I've put together some GitHub workflows to automate the management of AirCube firmware. Since it automates the firmware release process, it depends on Conventional Commits and Semantic Release. This would require commit messages to follow a standardized format to enable the automation. But it removes the need to tag/build/release firmware.

I've got it enabled on my fork. Wondered if this would be helpful.

Key components:

• .github/workflows
• package.json
• release.config.cjs

Excerpt from CONTRIBUTING.md guide:

• Commit messages: Use Conventional Commits. This is required for automated firmware versioning in GitHub Actions.

Semantic commit format (required)

Use this format:

type(scope): summary

Examples:

• feat(zigbee): add software build id reporting
• fix(i2c): avoid bus init race during boot
• feat(api)!: remove legacy history command

Allowed types: feat, fix, perf, refactor, build, ci, docs, style, test, chore, revert

Version bump rules used by CI:

• feat: minor bump (X.Y.Z -> X.(Y+1).0)
• fix and other allowed types: patch bump (X.Y.Z -> X.Y.(Z+1))
• ! or BREAKING CHANGE: major bump (X.Y.Z -> (X+1).0.0)

GitHub Actions firmware release flow

• Firmware releases are generated by semantic-release from Conventional Commits.
• Any push builds firmware and computes the next semantic version in CI.
• If commits since the latest tag require a release, CI publishes a GitHub release and uploads firmware artifacts.
• Pushes to master produce stable tags (v<semver>). Other branches publish -dev prereleases.

The firmware version embedded in the binary is injected by CI as PROJECT_VER using semantic-release version resolution.