richertunes/brainarr

Overview

This skill automates software releases, versioning, and changelog management for the Brainarr plugin. It enforces semantic versioning, generates release notes and CHANGELOG entries, packages and signs artifacts, and attaches them to GitHub releases. The skill integrates with existing GitHub Actions, Cosign signing, and SBOM generation to provide a repeatable, auditable release pipeline.

How this skill works

The skill reads a single source of truth VERSION file, updates project files (csproj, plugin.json) and creates a git tag to trigger the release workflow. It parses commit history (conventional commits) to produce formatted release notes and updates CHANGELOG.md. The CI workflow builds and tests the project, packages a ZIP plugin, generates checksums and an SBOM, performs keyless Cosign signing, and publishes assets to a GitHub release.

When to use it

• Preparing a new stable or pre-release (alpha/beta/rc) for Brainarr
• Automating version bumps across csproj, plugin.json, and VERSION
• Generating changelogs or release notes from commit history
• Publishing signed artifacts and SBOMs to GitHub releases
• Recovering from or diagnosing failed release workflows
• Creating hotfix or emergency releases with validation gates

Best practices

• Keep VERSION as the single source of truth and commit it before tagging
• Use conventional commits to enable automated changelog generation
• Run the full test suite locally before triggering a release workflow
• Validate that assembly and plugin.json versions match the VERSION file
• Include CHANGELOG.md updates and docs changes in the release commit
• Use pre-release suffixes (alpha, beta, rc) for non-production releases

Example use cases

• Create a new release v1.4.0: bump VERSION, update CHANGELOG, tag v1.4.0, and monitor the GitHub Actions workflow
• Generate release notes since v1.3.0 by parsing git history and producing formatted markdown for the GitHub release
• Fix a signing failure: inspect workflow logs, verify OIDC/Cosign permissions, and re-run the release after corrective changes
• Publish a hotfix: bump patch version, run tests, create a hotfix tag, and attach signed ZIP and SBOM to the release
• Maintain release metadata: ensure checksums, SPDX SBOM, and plugin manifest are generated and attached on every release