make-release_skill

Overview

This skill prepares a new release for the web3-ethereum-defi Python package by updating version metadata, normalizing the changelog, committing changes, and building distributable artifacts. It streamlines the manual steps required to publish a release while ensuring version consistency and a clear changelog history.

How this skill works

Provide a target version string and the skill updates the version field in pyproject.toml, restructures CHANGELOG.md by moving the Current section into a versioned heading with dates, and inserts a fresh Current placeholder. It then creates a git commit, pushes to master, runs poetry build, and verifies the produced .tar.gz and .whl artifacts contain the expected version. Finally it notifies you to upload the built packages to PyPI manually.

When to use it

• You are ready to publish a new release of the package and need version and changelog updates.
• Preparing pre-release or stable releases after merging feature or fix branches.
• When you want a repeatable, minimal-release process before uploading artifacts to PyPI.
• Before tagging or creating a release on the remote repository.

Best practices

• Run tests and CI before starting the release process to catch regressions early.
• Use a semver-compatible version string (e.g., 1.2.0) and confirm it matches your release policy.
• Review CHANGELOG.md entries to ensure each item has context before adding dates.
• Verify pyproject.toml and changelog edits locally before committing and pushing.
• Confirm poetry build output filenames include the expected version before attempting upload.

Example use cases

• Bump the library from 1.0 to 1.1 after merging several bug fixes and feature additions.
• Prepare a hotfix release by updating the version, documenting fixes in the changelog, and building packages.
• Standardize changelog entries and insert a Current placeholder for ongoing work.
• Create artifacts for manual PyPI upload when automated publishing is not available.