skills.rest
macalbert
macalbertCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

release-coherence

Orchestrates version bumps, changelogs, and documentation updates across CLI, GitHub Action, and SDK releases.

138|5|Updated Sep 19, 2024
Search Tags:#workflow#changelog#release management#sdk#monorepo#documentation sync#version bump
One-click install
npx skills add https://github.com/macalbert/envilder --skill release-coherence-macalbert
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: release-coherence
Source: https://github.com/macalbert/envilder/tree/main/.github/skills/release-coherence
Command: npx skills add https://github.com/macalbert/envilder --skill release-coherence-macalbert

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Releasing a new version of a CLI, GitHub Action, or SDK often leaves changelogs, READMEs, website pages, and examples out of sync. This Skill provides a unified checklist-driven workflow that keeps every documentation surface aligned whenever any component version changes. ## Core Features & Use Cases - Component-aware release steps: Maps each component (CLI, GHA, .NET/Python/Node.js/Go/Java SDKs) to its version source file, changelog path, and web surfaces. - Structured six-step workflow: Covers version bumping, changelog entries, ROADMAP updates, website updates, cross-reference checks, and build validation. - Delegation to specialized skills: Routes changelog formatting to doc-maintenance, new SDK wiring to sdk-release-checklist, and drift detection to doc-sync. - Use Case: After bumping the Python SDK version in pyproject.toml, follow the workflow to add a changelog entry, verify the website badge updates, update the SDK README and examples, and run a doc-sync audit before tagging the release. ## Quick Start Prepare the release for the Node.js SDK version 1.4.0 and verify that all documentation surfaces are updated.

Frequently Asked Questions about release-coherence

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

FAQPage Schema
How do I prepare a release for a CLI or SDK without missing documentation updates?▼

Follow the six-step workflow: bump the version in the canonical source file, add a changelog entry, update the ROADMAP if applicable, update website surfaces, cross-check READMEs and examples, then validate with a website build and doc-sync audit.

What files need updating when releasing a new SDK version?▼

Update the version source file (e.g., pyproject.toml or package.json), add a changelog entry in docs/changelogs, and if the API changed, update the SDK README, examples, DocsContent.astro section, and i18n keys. Version badges update automatically via the website build.

Does the website version badge need manual updates after a release?▼

No. Version badges auto-update through astro.config.mjs using globals like __SDK_*_VERSION__ or __CLI_VERSION__. You only need to verify the website build picks up the new version, avoiding hardcoded versions in HTML.

When should I delegate to the doc-sync skill during a release?▼

Delegate to doc-sync when you need a full cross-surface drift detection audit, especially after releases with API changes or when uncertain whether all documentation surfaces are aligned. It complements the manual cross-reference checklist.

What are common release documentation mistakes to avoid?▼

Common mistakes include hardcoding versions in website HTML, updating the changelog but not the docs when behavior changed, updating the website but not the SDK README, skipping i18n locale updates, and forgetting ROADMAP updates for completed features.

Related Skills

Explore More Software Engineering Skills→
openvettaopenvetta
154

release-checklist

Reviews changes for release readiness across compatibility, tests, migrations, documentation, and rollback.

Official
Basic
GenEducationGenEducation

bmad-os-release-module

Coordinate software releases with version bumps, changelog updates, git tagging, npm publishing, and GitHub release creation.

Official
Intermediate
me2reshme2resh
489

docs-audit

Audit documentation completeness and freshness using the Diataxis framework.

Community
Intermediate
reaatechreaatech
2

Changelog Generation

Generate CHANGELOG.md entries and version bumps from conventional commits using Changesets.

Community
Advanced