<!-- Provide a brief summary of your changes --> ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> The following PR addresses the feedback comments from #366 ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> ## Breaking Changes <!-- Will users need to update their code or configurations? --> No ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [ ] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions --> Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
1.5 KiB
1.5 KiB
Release Guide
Creating a Release
- Go to GitHub: Navigate to https://github.com/modelcontextprotocol/registry/releases
- Click "Draft a new release"
- Choose a tag: Click "Choose a tag" and type a new semantic version that follows the last one available (e.g.,
v1.0.0) - Generate notes: Click "Generate release notes" to auto-populate the name and description
- Publish: Click "Publish release"
The release workflow will automatically:
- Build binaries for 6 platforms (Linux, macOS, Windows × amd64, arm64)
- Create and push Docker images with
:latestand:vX.Y.Ztags - Attach all artifacts to the GitHub release
- Generate checksums and signatures
After Release
- Docker images will be available at:
ghcr.io/modelcontextprotocol/registry:latest- Latest stable releaseghcr.io/modelcontextprotocol/registry:vX.Y.Z- Specific release version
- Binaries can be downloaded from the GitHub release page
Docker Image Tags
The registry publishes different Docker image tags for different use cases:
:latest- Latest stable release (updated only on releases):vX.Y.Z- Specific release versions (e.g.,:v1.0.0):main- Rolling tag updated on every push to main branch (continuous deployment):main-YYYYMMDD-sha- Specific development builds from main branch
Versioning
We use semantic versioning (SemVer):
v1.0.0- Major release with breaking changesv1.1.0- Minor release with new featuresv1.0.1- Patch release with bug fixes