forked from zereight/gitlab-mcp
-
Notifications
You must be signed in to change notification settings - Fork 1
fix(docs): Replace hardcoded 'latest' MCPB link with versioned URL in README #204
Copy link
Copy link
Labels
Description
Summary
README.md.in uses a hardcoded gitlab-mcp-latest.mcpb link that no longer exists. The documentation site and GitHub releases use versioned MCPB bundles (e.g., gitlab-mcp-6.43.1.mcpb), but README.md still points to the non-existent latest file.
Problem
In README.md.in (line 7):
[](https://gitlab-mcp.sw.foundation/downloads/gitlab-mcp-latest.mcpb)This link returns 404 because:
- MCPB bundles are published with version numbers:
gitlab-mcp-6.43.1.mcpb - There is no
latest.mcpbfile on the docs site - The docs site uses
__VERSION__placeholder which gets replaced byinject-tool-refs.ts
Current Architecture
How docs work (correct):
docs/index.md.inusesgitlab-mcp-__VERSION__.mcpbinject-tool-refs.tsreplaces__VERSION__with actual version fromRELEASE_VERSIONenv orpackage.json- Generated
docs/index.mdhas correct versioned link
How README works (broken):
README.md.inuses hardcodedgitlab-mcp-latest.mcpbprepare-release.shonly replaces__TOOL_COUNT__,__ENTITY_COUNT__,__READONLY_TOOL_COUNT__- Generated
README.mdhas dead link
Solution
Option A: Extend prepare-release.sh (Recommended)
Add __VERSION__ replacement to prepare-release.sh:
# Line 46-49 in prepare-release.sh
sed -e "s/__TOOL_COUNT__/${TOOL_COUNT}/g" \
-e "s/__ENTITY_COUNT__/${ENTITY_COUNT}/g" \
-e "s/__READONLY_TOOL_COUNT__/${READONLY_TOOL_COUNT}/g" \
-e "s/__VERSION__/${VERSION}/g" \ # Add this line
README.md.in > README.mdAnd update README.md.in line 7:
[](https://gitlab-mcp.sw.foundation/downloads/gitlab-mcp-__VERSION__.mcpb)Option B: Process README.md.in through inject-tool-refs
This would require restructuring since inject-tool-refs.ts only scans docs/ directory, but README.md.in is in the project root.
Files to Change
| File | Change |
|---|---|
README.md.in |
Replace gitlab-mcp-latest.mcpb with gitlab-mcp-__VERSION__.mcpb |
scripts/prepare-release.sh |
Add __VERSION__ replacement in sed command |
Acceptance Criteria
- README.md.in uses
__VERSION__placeholder for MCPB link - prepare-release.sh replaces
__VERSION__when generating README.md - Generated README.md has correct versioned MCPB link (e.g.,
gitlab-mcp-6.43.1.mcpb) - Link resolves to actual file on docs site after release
Testing
After changes, run locally:
./scripts/prepare-release.sh 6.43.1
grep "mcpb" README.md
# Should show: gitlab-mcp-6.43.1.mcpbRelated
- MCPB generation:
scripts/build-mcpb.sh - Docs generation:
src/cli/inject-tool-refs.ts - CI workflow:
.github/workflows/docs.yml(uses RELEASE_VERSION for docs)
Labels
- bug
- docs
- good first issue
Reactions are currently unavailable