openseo-release-notes

Generates version bumps, curated release notes, and release PRs from git history.

1.1k|103|Updated Nov 28, 2024
One-click install
npx skills add https://github.com/VladSez/easy-invoice-pdf --skill openseo-release-notes
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: openseo-release-notes
Source: https://github.com/VladSez/easy-invoice-pdf/tree/main/.agents/skills/openseo-release-notes
Command: npx skills add https://github.com/VladSez/easy-invoice-pdf --skill openseo-release-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Preparing a software release involves tedious manual work: bumping versions, reading through commits since the last tag, writing user-facing release notes, and opening a properly formatted PR. This Skill automates that entire release-cutting workflow for the OpenSEO repository.

Core Features & Use Cases

  • Automated Version Bumping: Reads package.json and bumps the patch version, respecting existing bumps and explicit minor/major requests.
  • Commit-to-Notes Pipeline: Collects commits since the last git tag, fetches PR bodies and author handles via the GitHub CLI, and drafts concise release notes following a strict style guide with contributor credits.
  • Review and Verification Loop: Spawns reviewer and verification subagents to adversarially check the draft against guidelines and actual code before finalizing.
  • Use Case: A maintainer says "prepare the v0.0.26 release" and receives a version bump, a curated release-notes/v0.0.26.md file, and an open PR titled "release: v0.0.26" against main.

Quick Start

Ask the assistant to prepare a new OpenSEO release and draft release notes from the commits since the last tag.

Frequently Asked Questions about openseo-release-notes

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

FAQPage Schema
How do I generate release notes from git commits automatically?▼

This Skill lists commits since the latest git tag, fetches each PR's body and author with the GitHub CLI, and drafts a curated release-notes markdown file. It follows a strict style guide so the output is a scannable digest rather than a raw commit dump.

How to bump the version in package.json for a release?▼

The Skill reads package.json and bumps the patch version by default, such as 0.0.19 to 0.0.20. If the branch already contains a version bump it treats that as the source of truth, and minor or major bumps happen only when explicitly requested.

Does this release workflow work with any GitHub repository?▼

No, it is tailored to the OpenSEO repositories bensenescu/open-seo and every-app/open-seo. It hardcodes repo-specific PR lookups, the release-notes style exemplar, pnpm release scripts, and the Full Changelog compare links.

What changes get excluded from the drafted release notes?▼

The Skill cuts marketing-site changes, pricing and billing work, onboarding-flow changes, CI and refactors, and invisible backend work like security hardening or raised limits. Only product changes a self-hoster would notice while using the app are included.

Does the Skill publish the GitHub release itself?▼

No, it only opens a PR titled release: vX.X.X with the notes as the body. Tagging and publishing happen after merge via pnpm release:publish or an equivalent gh release create command.