Uh oh!
There was an error while loading. Please reload this page.
Update withWorkflow and update docs - #123
Merged
Merged
Conversation
🦋 Changeset detectedLatest commit: dff9e70 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
The latest updates on your projects. Learn more about Vercel for GitHub.
|
ijjkforce-pushed
the
ijjk/update-next-workflow
branch
from
October 28, 2025 20:28
3d1e5b0 to
cacc676Compareijjkforce-pushed
the
ijjk/update-next-workflow
branch
from
October 28, 2025 20:34
cacc676 to
dff9e70CompareTooTallNate
approved these changes
Oct 28, 2025
Uh oh!
There was an error while loading. Please reload this page.
13 tasks
vercelBot
added a commit
that referenced
this pull request
Jun 26, 2026
…tten summary verbatim, leaking injected `pr:`/`commit:` directive lines into the changelog so the entry title becomes literally `pr: #N`.
This commit fixes the issue reported at .changeset/changelog.mjs:368
## Bug
`maybeRewriteChangesetForBackport` prepends directive lines to a backport changeset's summary:
```js
const rewrittenSummary =
`pr: #${originalPRNumber}\n` +
`commit: ${changeset.commit}\n` +
summary;
return { ...changeset, summary: rewrittenSummary };
```
The upstream `@changesets/changelog-github` `getReleaseLine` consumes those directives and **strips them** from the summary (via `.replace(/^\s*(?:pr|pull|pull\s+request):.../im, ...)`, `commit:`, `author:` etc.) before splitting into `firstLine`/`futureLines` and rendering. So in the normal path the directives never appear in the output — that's the whole point of injecting them.
The offline fallback, however, does **not** strip them:
```js
function offlineReleaseLine(changeset, options) {
const [firstLine, ...futureLines] = (changeset.summary ?? '')
.split('\n')
.map((l) => l.trimEnd());
...
}
```
It just splits on `\n` and renders verbatim.
### Concrete trigger
A backport changeset where:
1. `maybeRewriteChangesetForBackport` **succeeds** (network up, PR resolved, directives injected → `rewritten.summary` starts with `pr: #N\ncommit: <sha>\n`), and
2. the subsequent `limitUpstream(() => upstream.getReleaseLine(rewritten, ...))` **throws** — exactly the flaky/oversized GraphQL batch scenario this fallback was added for.
The catch block then ran `offlineReleaseLine(rewritten, options)`, producing:
```
- [`abc1234`](...) - pr: #123
commit: abc1234...
<real first line>
```
The entry title becomes literally `pr: #123` and `commit: …` leaks as body text.
## Fix
Pass the **original** `changeset` to `offlineReleaseLine` instead of `rewritten`. The backport rewrite only mutates `summary`; `changeset.commit` is untouched, so the offline commit link is identical, while the original summary has no injected directives. The offline path already drops PR/author attribution it can't resolve, so using the un-rewritten summary is exactly correct.
The dependency-line path (`offlineDependencyReleaseLine`) is unaffected since no directive injection happens there.
Co-authored-by: Vercel <vercel[bot]@users.noreply.github.com>
Co-authored-by: VaguelySerious <mittgfu@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As noticed in #95 when a user is exporting a function from their
next.configalready they might not be aware that plugins can do this as well. This adds documentation for that case and also expandswithWorkflowfunction to handle other plugins doing this as well.Closes: #95