Skip to content

Conversation

@samerfarida
Copy link
Contributor

@samerfarida samerfarida commented Nov 29, 2025

What

This PR adds comprehensive documentation to clarify how commit hash/pin updates work and when Docker images are built after updates.

Why

Users were confused about:

  • Whether they need to manually create PRs when updating their MCP server
  • When Docker images are actually built and published after pin update PRs are merged
  • The complete lifecycle from pin update to image availability in Docker Hub
  • Lack of visibility into the publishing process and timeline

Changes

CONTRIBUTING.md

  • Added new "Updating Your MCP Server" section with:
    • Detailed explanation of automated vs manual update options
    • Complete lifecycle: automated pin update → PR creation → merge → image build → publication
    • Timeline expectations (24 hours after PR merge)
    • Requirements for automated updates (mcp/ namespace, GitHub-hosted, etc.)
    • Manual update process with git command example: git ls-remote https://github.com/<username/orgname>/mcp-repo-name.git HEAD | awk '{print $1}'
    • Troubleshooting Q&A for common questions
  • Updated section 4 to reference the new section and clarify the post-merge process

docs/configuration.md

  • Enhanced "Source Pinning" section to explain:
    • How automated updates work (nightly GitHub Action checks)
    • What happens after PR merge (image build, signing, SBOM generation)
    • Timeline clarification (24 hours)
    • Link to CONTRIBUTING.md for more details

README.md

  • Added FAQ section answering:
    • How to update MCP server versions
    • Timeline for image availability
    • Why automated PRs might not appear immediately

Impact

This documentation will help users understand:

  • They don't need to manually create PRs for Docker-built images - the automated system handles it
  • The expected timeline (24 hours) for image availability after pin updates
  • How to manually update if needed (with practical git command example)
  • Why their automated PR might not have appeared yet (daily schedule)
  • When updates are triggered (daily at 5 AM UTC) and when they complete (24h after PR merge)
  • How to check if pin update PRs were created

Related Issues

Fixes #757 - Fully addresses the request for documentation on the update process

Partially addresses #484 - Improves visibility through documentation:

  • ✅ Documents when updates are triggered/completed
  • ✅ Documents how to manually trigger updates via PR
  • ✅ Provides troubleshooting guidance for checking PR status
  • ⚠️ Does not address notifications for build failures (requires feature implementation)
  • ⚠️ Does not address Docker Scout Health Score documentation (separate topic)
  • ⚠️ Does not provide actual pipeline status/logs access (requires tooling)

Add comprehensive documentation explaining:
- How automated pin updates work (daily GitHub Action)
- When Docker images are built after pin update PRs are merged
- Timeline expectations (24 hours after PR merge)
- Manual update process with git command example
- Troubleshooting Q&A for common questions

This addresses user confusion about:
- Whether they need to manually create PRs for updates
- When images are actually built and published after pin updates
- The complete lifecycle from pin update to image availability

Changes:
- Added new 'Updating Your MCP Server' section in CONTRIBUTING.md
- Enhanced 'Source Pinning' section in docs/configuration.md
- Added FAQ section to README.md

Fixes the gap where users didn't understand the automated
update process and image build timing after PR merges.
@samerfarida samerfarida requested a review from a team as a code owner November 29, 2025 04:35
GitHub's anchor generation for emoji-prefixed headings removes the
emoji without adding an extra leading hyphen. The correct anchor
is #updating-your-mcp-server (not #-updating-your-mcp-server).

Fixes broken anchor links in:
- CONTRIBUTING.md (internal link)
- README.md (cross-reference)
- docs/configuration.md (cross-reference)
@samerfarida
Copy link
Contributor Author

This PR resolves the documentation requests in issue #757. The documentation now clearly explains:

  • Whether to update commit hash in fork vs creating a PR
  • The automated update process (no manual PR needed for Docker-built images)
  • The complete update workflow and timeline
  • How to manually trigger updates when needed

Fixes #757

@yzxbmlf
Copy link
Contributor

yzxbmlf commented Nov 29, 2025

Thank you Sammy! This documentation is much needed. I'm still stuck trying to get the latest version published in the MCP Registry for my MCP server. If the Docker team could help, that would be appreciated. (https://github.com/Cylera/cylera-mcp-server)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Help me understand the process for updating the version of my MCP server

2 participants