Skip to content

Commit b9c00aa

Browse files
authored
Use canonical release-notes template for RC and GA (modelcontextprotocol#2800)
RC: full description matching prior -RC releases — draft links, draft changelog, and the 'not final' NOTE block with the version-negotiation pointer. GA: same structure with versioned URLs and the NOTE block dropped. Both now write the body via a heredoc to --notes-file so the markdown (backticks, blockquote) survives intact. $VERSION comes from env and is regex-validated before these steps run.
1 parent 866bd96 commit b9c00aa

2 files changed

Lines changed: 21 additions & 9 deletions

File tree

.github/workflows/cut-release.yml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,23 @@ jobs:
5252
GH_TOKEN: ${{ github.token }}
5353
TARGET_SHA: ${{ github.sha }}
5454
run: |
55+
cat > /tmp/notes.md <<EOF
56+
This release marks the **release candidate (RC)** \`${VERSION}\` revision of the Model Context Protocol.
57+
58+
The specification is available in [draft form](https://modelcontextprotocol.io/specification/draft).
59+
60+
For a detailed overview of changes, see [${VERSION} draft changelog](https://modelcontextprotocol.io/specification/draft/changelog).
61+
62+
>[!NOTE]
63+
>**To users and implementers:** this specification is not final. Changes may be introduced between the RC and the final release. SDKs will adopt this version at their own pace, and the prior version of the spec may remain in use for an undetermined amount of time.
64+
>
65+
>Refer to the [Version Negotiation documentation](https://modelcontextprotocol.io/specification/draft/basic/lifecycle#version-negotiation) to learn about the process for clients and servers to determine the version of the protocol being used.
66+
EOF
5567
gh release create "${VERSION}-RC" \
5668
--target "$TARGET_SHA" \
5769
--prerelease \
5870
--title "MCP ${VERSION} RC" \
59-
--notes "Release candidate for the ${VERSION} revision of the Model Context Protocol specification.
60-
61-
The RC content is the current draft: https://modelcontextprotocol.io/specification/draft
62-
63-
Please file issues against SEPs in this milestone before the final cut."
71+
--notes-file /tmp/notes.md
6472
6573
- name: Summary
6674
run: |

.github/workflows/publish-release.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,15 @@ jobs:
4444
echo "tag ${VERSION} already exists — skipping"
4545
exit 0
4646
fi
47+
cat > /tmp/notes.md <<EOF
48+
This release marks the \`${VERSION}\` revision of the Model Context Protocol.
49+
50+
The specification is available at [modelcontextprotocol.io/specification/${VERSION}](https://modelcontextprotocol.io/specification/${VERSION}).
51+
52+
For a detailed overview of changes, see the [${VERSION} changelog](https://modelcontextprotocol.io/specification/${VERSION}/changelog).
53+
EOF
4754
gh release create "$VERSION" \
4855
--target "$TARGET_SHA" \
4956
--latest \
5057
--title "MCP ${VERSION}" \
51-
--notes "Model Context Protocol specification ${VERSION}.
52-
53-
https://modelcontextprotocol.io/specification/${VERSION}
54-
Changelog: https://modelcontextprotocol.io/specification/${VERSION}/changelog"
58+
--notes-file /tmp/notes.md

0 commit comments

Comments
 (0)