docs: clarify release deployment process and enable manual deploy trigger

- Add workflow_dispatch to deploy.yml for manual deployment triggers
- Document that releases don't auto-deploy to production
- Add instructions for deploying releases to production
- Add verification steps for deployment

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
tadasant 2025-09-29 18:54:56 -07:00
commit c40374c280
29 changed files with 134 additions and 112 deletions

View file

@ -4,6 +4,7 @@ on:
push: push:
branches: branches:
- main - main
workflow_dispatch:
permissions: permissions:
contents: read contents: read

View file

@ -16,10 +16,34 @@ The release workflow will automatically:
## After Release ## After Release
- Docker images will be available at: The release workflow will automatically:
- Build and publish Docker images:
- `ghcr.io/modelcontextprotocol/registry:latest` - Latest stable release - `ghcr.io/modelcontextprotocol/registry:latest` - Latest stable release
- `ghcr.io/modelcontextprotocol/registry:vX.Y.Z` - Specific release version - `ghcr.io/modelcontextprotocol/registry:vX.Y.Z` - Specific release version
- Binaries can be downloaded from the GitHub release page - Binaries will be available on the GitHub release page
**Important:** Creating a release does **not** automatically deploy to production. Production deployments are triggered by pushes to the `main` branch.
## Deploying the Release to Production
After creating a release, you need to ensure production pulls the new `:latest` Docker image. You have two options:
1. **Recommended:** Merge a commit to `main` (e.g., a changelog update or version bump). This will trigger the deployment workflow which will:
- Build and push a new `:main` Docker image
- Deploy to staging
- Deploy to production (which uses `:latest` and will pull the new image)
2. **Manual restart (requires kubectl access):**
```bash
kubectl rollout restart deployment/mcp-registry -n default
```
## Verifying the Deployment
After deployment completes, verify the changes are live:
- Check the deployment workflow succeeded: https://github.com/modelcontextprotocol/registry/actions/workflows/deploy.yml
- Test the API endpoint to confirm schema changes are applied
- Check migrations ran successfully in the pod logs
## Docker Image Tags ## Docker Image Tags

View file

@ -387,7 +387,6 @@ func TestDefaultHTTPKeyFetcher(t *testing.T) {
} }
} }
func TestHTTPAuthHandler_Permissions(t *testing.T) { func TestHTTPAuthHandler_Permissions(t *testing.T) {
cfg := &config.Config{ cfg := &config.Config{
JWTPrivateKey: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef", JWTPrivateKey: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
@ -738,4 +737,3 @@ func TestHTTPvsDNS_PermissionDifferences(t *testing.T) {
}) })
} }
} }

View file

@ -41,6 +41,7 @@ type ServerVersionsInput struct {
} }
// RegisterServersEndpoints registers all server-related endpoints // RegisterServersEndpoints registers all server-related endpoints
//
//nolint:cyclop // Multiple endpoint registrations are inherently complex //nolint:cyclop // Multiple endpoint registrations are inherently complex
func RegisterServersEndpoints(api huma.API, registry service.RegistryService) { func RegisterServersEndpoints(api huma.API, registry service.RegistryService) {
// List servers endpoint // List servers endpoint

Some files were not shown because too many files have changed in this diff Show more