create-release

Automate version increments, changelog compilation, and documentation updates for releases.

19|1|Updated Dec 26, 2022
One-click install
npx skills add https://github.com/grymmjack/DRAW --skill create-release-grymmjack
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-release
Source: https://github.com/grymmjack/DRAW/tree/main/.github/skills/create-release
Command: npx skills add https://github.com/grymmjack/DRAW --skill create-release-grymmjack

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the cumbersome process of preparing software releases, including version bumping, change log compilation, and documentation updates, saving time and reducing manual errors.

Core Features & Use Cases

  • Version Management: Parses current version from code and calculates the next release version based on user input.
  • Change Log Generation: Collects commit messages and pull request summaries to create detailed release notes.
  • Documentation Updates: Guides updates to _COMMON.BI, CHEATSHEET.md, README.MD, and instruction files to keep documentation aligned with the release.
  • Use Case: A developer is preparing a new release and needs to update version numbers, summarize changes, and ensure all docs reflect the latest updates effortlessly.

Quick Start

Instruct the AI to assist in preparing the release, including version calculation, change collection, and documentation updates, ensuring all steps are followed sequentially.

Frequently Asked Questions about create-release

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

FAQPage Schema
How do I automate version increments and changelog compilation for a new release?

Automating version increments and changelog compilation involves parsing current version strings, executing Git commands to collect commit messages, and editing markdown documentation to prepare a synchronized software release.

What is the best way to update documentation alongside a new software release?

The best way to update documentation during a software release is to automate edits to markdown files like README.MD and CHEATSHEET.md, ensuring all instructional docs reflect the latest version changes and release notes accurately.

How does automated release preparation calculate the next version number?

Automated release preparation calculates the next version number by parsing the current version string directly from the codebase and applying user-provided input to determine the appropriate version increment.

Can I use git commit messages to generate detailed release notes automatically?

Yes, you can generate detailed release notes automatically by collecting and summarizing git commit messages and pull request summaries into a compiled changelog during the release preparation process.

Do I need any external dependencies to streamline my release process with this method?

No external dependencies are required to streamline your release process, as the automation handles versioning and documentation updates natively by parsing code and executing standard Git commands.

What files are typically updated when automating software release documentation?

When automating software release documentation, the process typically updates markdown files such as README.MD, CHEATSHEET.md, instruction files, and code files like _COMMON.BI to align with the new version.