|
| 1 | +# Release Process for click-mcp |
| 2 | + |
| 3 | +This document outlines the steps to release a new version of click-mcp. |
| 4 | + |
| 5 | +## 1. Update Version Number |
| 6 | + |
| 7 | +1. Edit `pyproject.toml` and update the version number: |
| 8 | + |
| 9 | +```toml |
| 10 | +[project] |
| 11 | +name = "click-mcp" |
| 12 | +version = "X.Y.Z" # Update this line |
| 13 | +``` |
| 14 | + |
| 15 | +2. Commit the change: |
| 16 | + |
| 17 | +```bash |
| 18 | +git add pyproject.toml |
| 19 | +git commit -m "Bump version to X.Y.Z" |
| 20 | +``` |
| 21 | + |
| 22 | +## 2. Create a GitHub Release |
| 23 | + |
| 24 | +1. Push your changes to GitHub: |
| 25 | + |
| 26 | +```bash |
| 27 | +git push origin main |
| 28 | +``` |
| 29 | + |
| 30 | +2. Go to the GitHub repository: https://github.com/crowecawcaw/click-mcp |
| 31 | + |
| 32 | +3. Click on "Releases" in the right sidebar |
| 33 | + |
| 34 | +4. Click "Create a new release" |
| 35 | + |
| 36 | +5. Enter the following information: |
| 37 | + - Tag version: `vX.Y.Z` (e.g., `v0.1.1`) |
| 38 | + - Release title: `Version X.Y.Z` |
| 39 | + - Description: Add release notes describing the changes in this version |
| 40 | + |
| 41 | +6. Click "Publish release" |
| 42 | + |
| 43 | +## 3. Automatic PyPI Publishing |
| 44 | + |
| 45 | +The GitHub Actions workflow will automatically: |
| 46 | +1. Build the package |
| 47 | +2. Upload it to PyPI |
| 48 | +3. Make it available for installation via `pip install click-mcp` |
| 49 | + |
| 50 | +## 4. Verify the Release |
| 51 | + |
| 52 | +After the GitHub Actions workflow completes: |
| 53 | + |
| 54 | +1. Check that the package is available on PyPI: https://pypi.org/project/click-mcp/ |
| 55 | + |
| 56 | +2. Test installation in a clean environment: |
| 57 | + |
| 58 | +```bash |
| 59 | +pip install click-mcp==X.Y.Z |
| 60 | +``` |
| 61 | + |
| 62 | +## Version Numbering Guidelines |
| 63 | + |
| 64 | +Follow semantic versioning (SemVer): |
| 65 | + |
| 66 | +- **MAJOR** version (X): Incompatible API changes |
| 67 | +- **MINOR** version (Y): Add functionality in a backward-compatible manner |
| 68 | +- **PATCH** version (Z): Backward-compatible bug fixes |
| 69 | + |
| 70 | +For pre-releases, use suffixes like `-alpha.1`, `-beta.1`, etc. |
0 commit comments