Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
fix(release): tell beta reviewers that no docs pin PR follows
jkomyno committed
Nov 5, 2026 at 19:34 UTC
0aac4561aed8be95a28174ed23ece89f01392dad
2 files changed
+18
-6
scripts/sdk-release/release-pr.ts
+11
-2
@@ -75,18 +75,27 @@ const changesetLine = (note: Changeset) => {
75
/** How a release PR explains its channel to the reviewer. */
76
const CHANNEL_COPY: Record<
77
Channel,
78
- { readonly title: string; readonly summary: string; readonly notes: string }
78
+ {
79
+ readonly title: string;
80
+ readonly summary: string;
81
+ readonly notes: string;
82
+ readonly afterPublish: string;
83
+ }
84
> = {
85
stable: {
86
title: 'chore(release): publish SDK packages',
87
summary: 'A stable release: npm moves `latest` to these versions.',
88
notes: '## Changesets consumed',
89
+ afterPublish:
90
+ '5. After publishing, the bot opens a docs PR that pins the released npm versions, so twoslash checks the docs against them.',
91
},
92
beta: {
93
title: 'chore(release): publish SDK beta packages',
94
summary:
95
'A beta release: npm moves `next` to these versions and never touches `latest`, and pip installs them only with `--pre` or an exact pin. This PR commits only the release plan. The candidate checks apply its versions, so `next` keeps its stable versions and every changeset below stays pending for the stable release.',
96
notes: '## Changesets previewed',
97
+ afterPublish:
98
+ '5. A beta opens no docs PR: the docs keep following stable releases. The request issue lists the published versions.',
99
},
100
};
101
@@ -148,7 +157,7 @@ export const releasePullBody = (
157
`2. Review the diff and approve this head. Approval must come from a writer other than the requester (@${batch.requestedBy}). Do not push to this branch: the tag step only accepts the release bot's commit. To change the notes, fix the changesets on \`next\`, close this PR and request a new release.`,
158
`3. After approval and green checks, merge this PR. The release workflow rechecks the approval and tags this exact head \`sdk-release/${batch.id}\`; if the check fails, it creates no tag and asks you to revert this PR and request the release again.`,
159
'4. The tag run publishes the exact files the `SDK candidate` checks built and the `SDK candidate smoke` checks installed on this PR. If a publish job fails, use "Re-run failed jobs" on that run.',
151
- '5. After publishing, the bot opens a docs PR that pins the released npm versions, so twoslash checks the docs against them.',
160
+ copy.afterPublish,
161
].join('\n'),
162
`Request: ${issueUrl(batch)}\nPlanning run: ${runUrl(batch.id)}`,
163
];
test/sdk-release-batch.test.ts
+7
-4
@@ -153,10 +153,13 @@ describe('release PR', () => {
153
'POST /git/refs',
154
'POST /pulls',
155
]);
156
- expect(writes.find(write => write.path === '/pulls')?.body).toMatchObject({
157
- title: 'chore(release): publish SDK beta packages',
158
- body: expect.stringContaining('never touches `latest`'),
159
- });
156
+ const opened = writes.find(write => write.path === '/pulls')?.body as {
157
+ readonly title: string;
158
+ readonly body: string;
159
+ };
160
+ expect(opened.title).toBe('chore(release): publish SDK beta packages');
161
+ expect(opened.body).toContain('never touches `latest`');
162
+ expect(opened.body).toContain('A beta opens no docs PR');
163
});
164
165
test('a beta release PR that also writes a changelog is refused before any write', async () => {