fix(release): disable git-cliff GitHub remote fetch (panics on flaky API)#1428
Merged
Conversation
…API)
The changelog step panicked (changelog.rs:493 -> exit 101) fetching every
commit + every closed PR from the GitHub API and hitting a truncated response
("end of file before message length reached"). That remote data is unused —
the cliff.toml template references only local commit fields.
Drop GITHUB_REPO from the step env; git-cliff v2.13.1 (pinned by the action)
won't fetch without an explicit repo and doesn't auto-detect from origin
(verified). The action still supplies a token for its own binary download.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe release workflow's changelog generation step is updated to remove the ChangesRelease Workflow Changelog Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
The testnet dry-run failed at Generate changelog with a git-cliff panic:
git-cliff was fetching every commit + every closed PR from the GitHub API (
add_remote_data) and panicked on a flaky/truncated response (exit 101).Why it's safe to remove
The
cliff.tomlbody template uses only local commit fields (message/scope/breaking/group) — none of the GitHub remote data. The fetch is pure overhead and the sole failure source.Fix
Stop passing
GITHUB_REPOto the changelog step. git-cliff (v2.13.1, pinned by the action) does not fetch remote data without an explicit repo and does not auto-detect it fromorigin(verified locally: token present + noGITHUB_REPO=> zero API requests). The action still injects a token for its own binary download.Test plan
--ref fix/changelog-no-remotebuildingrelease/testnet/3.x: Generate changelog succeeds, no API fetch, publish steps skipped.Summary by CodeRabbit