Release/3.1.0

[bessman]

Summary by Sourcery

Prepare for the 3.1.0 release by adding support for building for v5 hardware and ESP01 targets. Update the CI workflow to build multiple targets and create draft releases with attached artifacts automatically.

Build:

• Set up building for v5 hardware.
• Set up building for ESP01 targets.
• Publish artifacts for v5, v6 and ESP01 targets.
• Update compiler cache key to prevent cache misses when switching between branches and build types.
• Checkout ESP01 branch during CI build process.
• Update checkout action to v4 and add path to main branch checkout.
• Add submodules for ESP01 branch during CI build process.
• Create separate build directories for each build type during CI process.
• Add build type matrix to CI workflow to build for v5, v6, and v6_esp01 targets.
• Add cmake flags for legacy hardware and build type to CI workflow matrix.
• Update firmware version to 3.1.0

CI:

• Add CI workflow to automatically create draft releases and attach build artifacts on new tags. Publish artifacts for v5, v6, and v6_esp01 targets.
• Set up changelog parsing in release workflow to generate release notes automatically.
• Install pcregrep in the release workflow to parse the changelog correctly.
• Update checkout action to v4 in the release workflow.
• Add workflow call trigger to the main-builder workflow.
• Update upload artifact action to v4 and add correct artifact name and path for each build type.
• Add matrix strategy to build workflow to build for v5, v6, and v6_esp01 targets.
• Update checkout action to v3.
• Cache XC-16 Compiler in CI.
• Download XC16 Compiler if not cached.
• Install XC16 Compiler.
• Set up cmake-microchip submodules.
• Build firmware.
• Publish build files as artifact named 'production-file'.

Documentation:

• Document how to build for v5 hardware

[sourcery-ai]

Reviewer's Guide by Sourcery

This release includes an increase in the UART timeout, documentation for building for v5 hardware, and updates to the build process to support v5 hardware and create builds for different configurations. The release process was also automated.

Updated class diagram for the device version

classDiagram
    class VERSION_FW {
        -major: uint8_t
        -minor: uint8_t
        -patch: uint8_t
    }
    note for VERSION_FW "Version changed from 3.0.4 to 3.1.0"

Loading

File-Level Changes

Change	Details	Files
The build process was updated to support building for v5 hardware and to create builds for different configurations.	Added a build matrix to the main-builder workflow to build for v6, v5, and v6_esp01 configurations. Modified the build process to use the build matrix to create separate build directories for each configuration. Added a new workflow file for releases. Added steps to the release workflow to parse the changelog and attach the build artifacts to the release.	.github/workflows/main-builder.yml .github/workflows/release.yml
The UART timeout was increased.	Incremented the minor version number from 3.0.4 to 3.1.0 in device.c. Added a changelog entry for the UART timeout increase.	CHANGELOG.md src/helpers/device.c
The build process for v5 hardware was documented.	Added a changelog entry documenting how to build for v5 hardware.	CHANGELOG.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @bessman - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider using a single checkout action and then using git checkout to switch between branches.
• The release workflow could be simplified by directly using the output of the build job.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

issue (typo): Typo: "refactorization" should be "refactoring"

Suggested change

	_Major refactorization of firmware._
	_Major refactoring of firmware._