Skip to content

RELEASE_PROCESS.md

Latest commit

 

History

History
81 lines (52 loc) · 1.73 KB

RELEASE_PROCESS.md

File metadata and controls

81 lines (52 loc) · 1.73 KB

Release Process for click-mcp

This document outlines the steps to release a new version of click-mcp.

1. Update Version Number

  1. Edit pyproject.toml and update the version number:
[project]
name = "click-mcp"
version = "X.Y.Z"  # Update this line
  1. Commit the change:
git add pyproject.toml
git commit -m "Bump version to X.Y.Z"

2. Run Quality Checks

  1. Ensure all tests pass and code quality checks succeed:
hatch run lint:all
hatch run test:cov
  1. Fix any issues that arise from these checks.

3. Create a GitHub Release

  1. Push your changes to GitHub:
git push origin main

  1. Go to the GitHub repository: https://github.com/crowecawcaw/click-mcp

  2. Click on "Releases" in the right sidebar

  3. Click "Create a new release"

  4. Enter the following information:

    • Tag version: vX.Y.Z (e.g., v0.1.1)
    • Release title: Version X.Y.Z
    • Description: Add release notes describing the changes in this version

  5. Click "Publish release"

4. Automatic PyPI Publishing

The GitHub Actions workflow will automatically:

  1. Build the package
  2. Upload it to PyPI
  3. Make it available for installation via pip install click-mcp

5. Verify the Release

After the GitHub Actions workflow completes:

  1. Check that the package is available on PyPI: https://pypi.org/project/click-mcp/

  2. Test installation in a clean environment:

pip install click-mcp==X.Y.Z

Version Numbering Guidelines

Follow semantic versioning (SemVer):

  • MAJOR version (X): Incompatible API changes
  • MINOR version (Y): Add functionality in a backward-compatible manner
  • PATCH version (Z): Backward-compatible bug fixes

For pre-releases, use suffixes like -alpha.1, -beta.1, etc.