mflux-release

Prepares mflux release branches with version bumps and uv lockfile updates.

2.4k|187|Updated Aug 10, 2024
One-click install
npx skills add https://github.com/mflux-community/mflux --skill mflux-release-mflux-community
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: mflux-release
Source: https://github.com/mflux-community/mflux/tree/main/.cursor/skills/mflux-release
Command: npx skills add https://github.com/mflux-community/mflux --skill mflux-release-mflux-community

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Preparing an mflux release involves several easy-to-forget steps: bumping the version in pyproject.toml, regenerating the uv lockfile, and following the PR-based release-note convention. This Skill encodes the exact release-prep checklist so nothing is missed. ## Core Features & Use Cases - Release-prep checklist: Bump the version in pyproject.toml, run uv lock, and commit as "release: prepare <version>". - Release-note conventions: Explains how fenced release-note blocks in PR bodies are harvested into draft GitHub Releases, and that the prep PR itself uses "none". - CI boundary clarity: Tagging and publishing are handled by the release.yml GitHub Actions workflow, so local tagging is avoided unless explicitly requested. - Use Case: When asked to prepare release v0.9.0, the Skill guides editing pyproject.toml, running uv lock, optionally running just test-fast and just build, and opening a release PR with the correct release-note block. ## Quick Start Prepare a release branch for mflux version 0.9.0 by bumping pyproject.toml and updating the uv lockfile.

Frequently Asked Questions about mflux-release

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

FAQPage Schema
How do I prepare a release for mflux?▼

Bump the version in pyproject.toml, run uv lock to update the lockfile, and commit everything as "release: prepare <version>". Open a PR whose release-note block is set to none; tagging and publishing are handled by CI.

Where do mflux release notes come from?▼

Release notes are harvested from fenced release-note blocks in each PR body. The draft-notes job in release.yml collects blocks for PRs in previous-tag..HEAD and fills a draft GitHub release grouped by label.

Does mflux use a CHANGELOG.md file?▼

No, mflux has no CHANGELOG.md. Release notes live in GitHub Releases, generated from PR release-note blocks and edited by whoever approves the pypi deployment before publishing.

Should I tag an mflux release locally?▼

No, do not tag releases locally unless explicitly requested. Tagging and publishing are handled by the release.yml GitHub Actions workflow, dispatched from main with the publish confirmation.

What happens if I re-dispatch the mflux release workflow?▼

A re-dispatch never overwrites an existing draft GitHub release. To re-harvest release notes from PR blocks, delete the existing draft first, then dispatch the workflow again.