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:
parent
df018fc43b
commit
c40374c280
29 changed files with 134 additions and 112 deletions
1
.github/workflows/deploy.yml
vendored
1
.github/workflows/deploy.yml
vendored
|
|
@ -4,6 +4,7 @@ on:
|
|||
push:
|
||||
branches:
|
||||
- main
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
|
|
|||
|
|
@ -308,7 +308,7 @@ func createServerJSON(
|
|||
URL: repoURL,
|
||||
Source: repoSource,
|
||||
},
|
||||
Version: version,
|
||||
Version: version,
|
||||
Packages: []model.Package{pkg},
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ func SetupIngressController(ctx *pulumi.Context, cluster *providers.ProviderInfo
|
|||
Values: pulumi.Map{
|
||||
"controller": pulumi.Map{
|
||||
"service": pulumi.Map{
|
||||
"type": serviceType,
|
||||
"type": serviceType,
|
||||
"annotations": pulumi.Map{},
|
||||
},
|
||||
"config": pulumi.Map{
|
||||
|
|
|
|||
|
|
@ -16,10 +16,34 @@ The release workflow will automatically:
|
|||
|
||||
## 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: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
|
||||
|
||||
|
|
|
|||
|
|
@ -387,7 +387,6 @@ func TestDefaultHTTPKeyFetcher(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
|
||||
func TestHTTPAuthHandler_Permissions(t *testing.T) {
|
||||
cfg := &config.Config{
|
||||
JWTPrivateKey: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
|
||||
|
|
@ -738,4 +737,3 @@ func TestHTTPvsDNS_PermissionDifferences(t *testing.T) {
|
|||
})
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -97,8 +97,8 @@ func RegisterEditEndpoints(api huma.API, registry service.RegistryService, cfg *
|
|||
|
||||
// Prevent undeleting servers - once deleted, they stay deleted
|
||||
if currentServer.Meta.Official != nil &&
|
||||
currentServer.Meta.Official.Status == model.StatusDeleted &&
|
||||
newStatus != model.StatusDeleted {
|
||||
currentServer.Meta.Official.Status == model.StatusDeleted &&
|
||||
newStatus != model.StatusDeleted {
|
||||
return nil, huma.Error400BadRequest("Cannot change status of deleted server. Deleted servers cannot be undeleted.")
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -162,9 +162,9 @@ func TestPublishIntegration(t *testing.T) {
|
|||
|
||||
t.Run("publish fails with invalid token", func(t *testing.T) {
|
||||
publishReq := apiv0.ServerJSON{
|
||||
Name: "io.github.domdomegg/test-server",
|
||||
Description: "Test server",
|
||||
Version: "1.0.0",
|
||||
Name: "io.github.domdomegg/test-server",
|
||||
Description: "Test server",
|
||||
Version: "1.0.0",
|
||||
}
|
||||
|
||||
body, err := json.Marshal(publishReq)
|
||||
|
|
@ -185,7 +185,7 @@ func TestPublishIntegration(t *testing.T) {
|
|||
publishReq := apiv0.ServerJSON{
|
||||
Name: "io.github.other/test-server",
|
||||
Description: "A test server",
|
||||
Version: "1.0.0",
|
||||
Version: "1.0.0",
|
||||
Repository: model.Repository{
|
||||
URL: "https://github.com/example/test-server",
|
||||
Source: "github",
|
||||
|
|
@ -221,7 +221,7 @@ func TestPublishIntegration(t *testing.T) {
|
|||
publishReq := apiv0.ServerJSON{
|
||||
Name: "io.github.domdomegg/airtable-mcp-server",
|
||||
Description: "A test server with MCPB package",
|
||||
Version: "1.7.2",
|
||||
Version: "1.7.2",
|
||||
Packages: []model.Package{
|
||||
{
|
||||
RegistryType: model.RegistryTypeMCPB,
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ func TestPublishRegistryValidation(t *testing.T) {
|
|||
publishReq := apiv0.ServerJSON{
|
||||
Name: "com.example/test-server-with-npm",
|
||||
Description: "A test server with invalid npm package reference",
|
||||
Version: "1.0.0",
|
||||
Version: "1.0.0",
|
||||
Packages: []model.Package{
|
||||
{
|
||||
RegistryType: model.RegistryTypeNPM,
|
||||
|
|
@ -88,7 +88,7 @@ func TestPublishRegistryValidation(t *testing.T) {
|
|||
publishReq := apiv0.ServerJSON{
|
||||
Name: "com.example/test-server-mcpb-validation",
|
||||
Description: "A test server with MCPB package and registry validation enabled",
|
||||
Version: "0.0.36",
|
||||
Version: "0.0.36",
|
||||
Packages: []model.Package{
|
||||
{
|
||||
RegistryType: model.RegistryTypeMCPB,
|
||||
|
|
@ -138,7 +138,7 @@ func TestPublishRegistryValidation(t *testing.T) {
|
|||
publishReq := apiv0.ServerJSON{
|
||||
Name: "com.example/test-server-multiple-packages",
|
||||
Description: "A test server with multiple packages where second fails",
|
||||
Version: "1.0.0",
|
||||
Version: "1.0.0",
|
||||
Packages: []model.Package{
|
||||
{
|
||||
RegistryType: model.RegistryTypeMCPB,
|
||||
|
|
@ -189,7 +189,7 @@ func TestPublishRegistryValidation(t *testing.T) {
|
|||
publishReq := apiv0.ServerJSON{
|
||||
Name: "com.example/test-server-first-package-fails",
|
||||
Description: "A test server where first package fails",
|
||||
Version: "1.0.0",
|
||||
Version: "1.0.0",
|
||||
Packages: []model.Package{
|
||||
{
|
||||
RegistryType: model.RegistryTypeNPM,
|
||||
|
|
|
|||
|
|
@ -113,9 +113,9 @@ func TestPublishEndpoint(t *testing.T) {
|
|||
{
|
||||
name: "invalid authorization header format",
|
||||
requestBody: apiv0.ServerJSON{
|
||||
Name: "io.github.domdomegg/test-server",
|
||||
Description: "Test server",
|
||||
Version: "1.0.0",
|
||||
Name: "io.github.domdomegg/test-server",
|
||||
Description: "Test server",
|
||||
Version: "1.0.0",
|
||||
},
|
||||
authHeader: "InvalidFormat",
|
||||
setupRegistryService: func(_ service.RegistryService) {
|
||||
|
|
@ -129,7 +129,7 @@ func TestPublishEndpoint(t *testing.T) {
|
|||
requestBody: apiv0.ServerJSON{
|
||||
Name: "test-server",
|
||||
Description: "A test server",
|
||||
Version: "1.0.0",
|
||||
Version: "1.0.0",
|
||||
},
|
||||
authHeader: "Bearer invalidToken",
|
||||
setupRegistryService: func(_ service.RegistryService) {
|
||||
|
|
@ -143,7 +143,7 @@ func TestPublishEndpoint(t *testing.T) {
|
|||
requestBody: apiv0.ServerJSON{
|
||||
Name: "io.github.other/test-server",
|
||||
Description: "A test server",
|
||||
Version: "1.0.0",
|
||||
Version: "1.0.0",
|
||||
Repository: model.Repository{
|
||||
URL: "https://github.com/example/test-server",
|
||||
Source: "github",
|
||||
|
|
@ -167,7 +167,7 @@ func TestPublishEndpoint(t *testing.T) {
|
|||
requestBody: apiv0.ServerJSON{
|
||||
Name: "example/test-server",
|
||||
Description: "A test server",
|
||||
Version: "1.0.0",
|
||||
Version: "1.0.0",
|
||||
Repository: model.Repository{
|
||||
URL: "https://github.com/example/test-server",
|
||||
Source: "github",
|
||||
|
|
@ -185,7 +185,7 @@ func TestPublishEndpoint(t *testing.T) {
|
|||
existingServer := apiv0.ServerJSON{
|
||||
Name: "example/test-server",
|
||||
Description: "Existing test server",
|
||||
Version: "1.0.0",
|
||||
Version: "1.0.0",
|
||||
Repository: model.Repository{
|
||||
URL: "https://github.com/example/test-server-existing",
|
||||
Source: "github",
|
||||
|
|
@ -202,7 +202,7 @@ func TestPublishEndpoint(t *testing.T) {
|
|||
requestBody: apiv0.ServerJSON{
|
||||
Name: "com.example/test-server-mcpb",
|
||||
Description: "A test server with MCPB package",
|
||||
Version: "1.0.0",
|
||||
Version: "1.0.0",
|
||||
Packages: []model.Package{
|
||||
{
|
||||
RegistryType: model.RegistryTypeMCPB,
|
||||
|
|
|
|||
|
|
@ -41,6 +41,7 @@ type ServerVersionsInput struct {
|
|||
}
|
||||
|
||||
// RegisterServersEndpoints registers all server-related endpoints
|
||||
//
|
||||
//nolint:cyclop // Multiple endpoint registrations are inherently complex
|
||||
func RegisterServersEndpoints(api huma.API, registry service.RegistryService) {
|
||||
// List servers endpoint
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue