release-please

Automate GitHub releases with Conventional Commits versioning and firmware binary deployment.

25|7|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/smart-swimmingpool/pool-controller --skill release-please-smart-swimmingpool
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: release-please
Source: https://github.com/smart-swimmingpool/pool-controller/tree/main/.opencode/skills/release-please
Command: npx skills add https://github.com/smart-swimmingpool/pool-controller --skill release-please-smart-swimmingpool

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the end-to-end release workflow for the pool-controller project by applying release-please and Conventional Commits to determine version bumps, generate changelogs, and publish GitHub Releases along with the firmware binary.

Core Features & Use Cases

  • Automated versioning based on Conventional Commits, including Major / Minor / Patch bumps.
  • End-to-end release PR workflow: update changelog, bump versions in platformio.ini and Version.h, build firmware.bin, and publish release with binary.
  • Suitable for developers who want a reliable, auditable release process that integrates with GitHub Releases and OTA firmware deployment.

Quick Start

Push commits to main to trigger automatic release creation via release-please.

Frequently Asked Questions about release-please

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

FAQPage Schema
How do I automate firmware release workflows using Conventional Commits?

Automating firmware release workflows with Conventional Commits involves analyzing commit messages to determine version bumps, automatically updating changelogs, and creating release PRs. This process manages version files and publishes firmware binaries directly to GitHub Releases.

How does release-please handle semver version bumps for firmware projects?

Semver version bumps for firmware projects are handled by parsing Conventional Commit prefixes to trigger Major, Minor, or Patch updates. The automation applies these bumps to configuration files like platformio.ini and Version.h during the release creation process.

What do I need to set up before automating GitHub Releases for my firmware binary?

Before automating GitHub Releases for your firmware binary, you need a release-please configuration file and a build step that compiles the firmware. The system uses these to update platformio.ini, Version.h, and publish the compiled binary.

Can I use Conventional Commits to manage OTA firmware deployment through GitHub Releases?

Yes, Conventional Commits can manage OTA firmware deployment by automatically generating GitHub Releases that include the compiled firmware binary. Pushing commits to the main branch triggers the release pipeline, building and attaching the binary for OTA updates.

When should I not use an automated release workflow for versioning my firmware?

You should not use an automated release workflow for firmware versioning if your project lacks a strict Conventional Commits structure or if you need manual control over binary deployment. The system relies entirely on commit message prefixes to determine version bumps.