mflux-release

Bump version, update changelog, and refresh uv lock for release PRs.

2.3k|169|Updated Aug 10, 2024

Search Tags:#changelog #release #git-pr #version-bump #uv-lock #in-repo

Ready to run

npx skills add https://github.com/filipstrand/mflux --skill mflux-release

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: mflux-release
Source: https://github.com/filipstrand/mflux/tree/main/.cursor/skills/mflux-release
Command: npx skills add https://github.com/filipstrand/mflux --skill mflux-release

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates preparing a release in the repository by bumping the version, updating the changelog, and refreshing the uv lock without tagging or publishing.

Core Features & Use Cases

In-repo release prep: Automates version bumps in pyproject.toml, changelog entry creation, and lockfile updates to keep releases consistent before PR creation.
Changelog synchronization: Ensures changelog reflects the latest commits since the last release tag.
Workflow integration: Fits into in-repo release PR workflows, leaving tagging/publishing to CI.

Quick Start

Use the Cursor command /release-prep to start a release PR, then follow the prompts to bump the version, update CHANGELOG.md, and run uv lock.

Frequently Asked Questions about mflux-release

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

FAQPage Schema

How do I prepare an in-repo release PR without creating a git tag?▼

To prepare an in-repo release without tagging, you can bump the version in pyproject.toml, update CHANGELOG.md, and refresh the uv lockfile. This leaves tagging and publishing to your CI pipeline after the PR merges.

What is the best way to automate version bumps and changelog updates for a Python project?▼

Automating version bumps and changelog updates involves modifying pyproject.toml and CHANGELOG.md to reflect new commits. Running `uv lock` then refreshes the lockfile, ensuring all release artifacts are consistent before PR creation.

How do I update the uv lockfile when bumping a project version?▼

You update the uv lockfile after a version bump by running the `uv lock` command. This ensures your lockfile reflects the newly updated version specified in your pyproject.toml before you merge.

Does this in-repo release workflow support manual sanity checks before publishing?▼

Yes, the in-repo release workflow supports optional sanity checks and manual testing steps. You can verify the version bump, changelog, and lockfile updates locally before merging and triggering the CI publish.

Can I synchronize my changelog with the latest commits since the last release tag?▼

Yes, changelog synchronization updates CHANGELOG.md to reflect the latest commits since the last release tag. This ensures your changelog accurately documents all changes included in the upcoming version bump.

Why should I use an in-repo release workflow instead of tagging directly?▼

An in-repo release workflow keeps tagging and publishing isolated to CI, allowing you to prepare and review version bumps, changelog updates, and lockfile changes in a PR before the actual release happens.