prepare-release

Prepare firmware releases by bumping versions, compiling boards, running tests, and creating changelogs.

Updated Sep 19, 2019
One-click install
npx skills add https://github.com/TizioMaurizio/ArduinoWorkshop --skill prepare-release-tiziomaurizio
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: prepare-release
Source: https://github.com/TizioMaurizio/ArduinoWorkshop/tree/main/Projects/ESP32-CAM-PlatformIO/.github/skills/prepare-release
Command: npx skills add https://github.com/TizioMaurizio/ArduinoWorkshop --skill prepare-release-tiziomaurizio

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill streamlines the process of preparing firmware releases, ensuring all necessary steps for version control, compilation, testing, and deployment are followed efficiently.

Core Features & Use Cases

  • Version Control: Manages version bumping according to semantic versioning standards.
  • Compilation Matrix: Provides a checklist for compiling firmware for all supported boards.
  • Binary Size Reporting: Documents binary sizes for flash and RAM usage, with comparisons to previous versions.
  • Test Execution: Runs both host-side and on-device tests to verify functionality.
  • Changelog Creation: Automates the generation of a changelog following a standard format.
  • Binary Creation: Builds release binaries and generates SHA256 checksums for verification.
  • Flash Instructions: Provides detailed instructions for flashing the binary to the target hardware.
  • Documentation Update: Updates project documentation with the new release information.

Quick Start

Run the prepare-release skill to update the version, compile the project, run tests, and create a changelog for your next firmware release.

Frequently Asked Questions about prepare-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate firmware release preparation with changelog generation and version bumping?

Firmware release preparation is automated by managing semantic version bumping, compiling all supported board targets, generating binary size reports, and creating standard format changelogs. The process assumes existing build scripts and test frameworks to execute end-to-end release steps efficiently.

What is included in binary size reporting for firmware releases?

Binary size reporting documents flash and RAM usage metrics for compiled firmware, including comparisons to previous versions. This tracking helps monitor memory footprint changes across supported board targets during the release cycle.

How do I run comprehensive tests before a firmware release?

Comprehensive test execution for firmware releases involves running both host-side and on-device tests to verify functionality. The process assumes an existing test framework and validates all supported board targets before generating final release binaries with SHA256 checksums.

Can I use this release preparation workflow without existing version control and build scripts?

Release preparation workflows require existing version control, build scripts, and test frameworks to function properly. The process orchestrates these established components rather than creating them, ensuring all supported board targets compile and pass verification before deployment.

What's the best way to generate flashing instructions for firmware releases?

Flashing instructions for firmware releases are generated automatically after compiling board targets and creating release binaries with SHA256 checksums. The instructions detail how to flash the verified binary to target hardware, completing the release documentation alongside changelog and binary size report updates.

Why does firmware release preparation include SHA256 checksums for binaries?

SHA256 checksums for release binaries provide cryptographic verification that compiled firmware matches the intended release version. Combined with binary size reports and changelog documentation, these checksums ensure release integrity before users flash binaries to target hardware.