prepare-release

Verify changelog, README, and version in pyproject.toml for TorchJD releases.

392|21|Updated Jun 1, 2024

Search Tags:#changelog #versioning #documentation #pull request #github #release

Ready to run

npx skills add https://github.com/SimplexLab/TorchJD --skill prepare-release-simplexlab

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: prepare-release
Source: https://github.com/SimplexLab/TorchJD/tree/main/skills/prepare-release
Command: npx skills add https://github.com/SimplexLab/TorchJD --skill prepare-release-simplexlab

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the TorchJD release workflow so a maintainer can verify release readiness, keep documentation consistent, and update versioned metadata without missing important steps.

Core Features & Use Cases

Release validation: Checks the changelog against recent changes to catch missing user-facing updates.
Documentation review: Verifies the README reflects public interface changes before a release is cut.
Version management: Updates the project version in pyproject.toml and prepares the changelog for the new release.
Release coordination: Guides the branch, commit, pull request, and draft GitHub release steps needed to complete the process.

Quick Start

Ask the assistant to prepare the next TorchJD release version and verify the changelog, README, version bump, and release PR steps.

Frequently Asked Questions about prepare-release

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

FAQPage Schema

How do I prepare a Python package release and verify the changelog and version bump?▼

Preparing a package release involves verifying the changelog against recent changes, checking README consistency, bumping the version in pyproject.toml, and coordinating the release pull request workflow to ensure draft publication readiness.

How do I validate semantic versioning and documentation before publishing a GitHub release?▼

Validating semantic versioning before a GitHub release requires reading project metadata, confirming the README reflects public interface changes, and checking the changelog completeness to catch missing user-facing updates.

What is the standard release workflow for updating project versioning and opening a release pull request?▼

The standard release workflow guides maintainers through branching, committing the version bump, opening a pull request, and preparing the draft GitHub release steps needed to complete the process.

How do I check if my changelog is complete before cutting a new package version?▼

Checking changelog completeness involves validating release notes against recent changes to catch missing user-facing updates, ensuring documentation synchronization before bumping the project version.

Can I use this release coordination process for maintainers handling versioned package releases?▼

Yes, this release coordination process is designed for maintainers handling versioned package releases, pre-release quality checks, and documentation synchronization for draft publication.

What steps are required to update pyproject.toml and prepare the changelog for a new release?▼

Updating pyproject.toml and preparing the changelog requires validating semantic versioning, applying the version bump, and verifying that the README reflects public interface changes before opening the release pull request.