Engineering
release-prep avatar

release-prep

Automates the release preparation process for MassGen by generating CHANGELOG entries, creating announcement drafts, and validating documentation integrity before git tagging.

Introduction

The release-prep skill is a specialized automation utility designed to streamline the software release lifecycle for the MassGen repository. It serves developers and release managers by consolidating manual documentation tasks into a single, reliable command executed prior to git tagging. By analyzing git history, commit logs, and pull request data, this skill ensures that project documentation remains consistent, structured, and up-to-date across multiple platforms including the changelog, README, and configuration files.

  • Automatically identifies changes since the last version tag by parsing git logs and merged pull requests.

  • Updates CHANGELOG.md with structured entries following the Keep a Changelog format, highlighting added features, fixed bugs, and documentation updates.

  • Archives previous release announcements into the docs/announcements/archive directory to maintain historical records.

  • Synchronizes documentation across core project files, including updating the Recent Releases section in Sphinx-based documentation (index.rst) and the release history in massgen/configs/README.md.

  • Regenerates the Latest Features section in the main repository README.md, ensuring new release highlights, usage examples, and achievement summaries are current.

  • Performs validation checks to verify documentation links, file paths (such as .rst, .md, .yaml), and contributor lists are accurate.

  • Usage requires providing a version string, for example: /release-prep v0.1.34.

  • The tool is best executed after merging a release PR into the main branch but before final tag creation.

  • It provides specific instructions for updating social media announcements on LinkedIn and X, respecting character limits and formatting requirements.

  • Users should ensure they have proper git history access to retrieve commit summaries and shortlogs.

  • By enforcing consistent release notes and documentation updates, this skill reduces human error in public-facing release communications and helps maintain high-quality project visibility.

Repository Stats

Stars
968
Forks
151
Open Issues
6
Language
Python
Default Branch
main
Sync Status
Idle
Last Synced
Apr 29, 2026, 07:09 AM
View on GitHub