Add CI check that protocol bumps come with an overlay version bump#5316
Open
sisuresh wants to merge 1 commit into
Open
Add CI check that protocol bumps come with an overlay version bump#5316sisuresh wants to merge 1 commit into
sisuresh wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a guardrail in CI to ensure that whenever Config::CURRENT_LEDGER_PROTOCOL_VERSION is bumped, the maximum supported overlay protocol version (OVERLAY_PROTOCOL_VERSION) is also bumped, keeping peer capability signaling aligned with protocol upgrades.
Changes:
- Added a repo script that compares protocol/overlay version constants between a base revision and the PR head (or working tree).
- Added a public CI job (
protocol-version-check) to run that script on PR/merge-group events and wired it into thecompleteaggregator job. - Added an equivalent job in the private CI workflow.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
scripts/check-protocol-overlay-versions.sh |
New script that diffs ledger/overlay protocol constants across git revisions and fails if overlay wasn’t bumped alongside a ledger protocol bump. |
.github/workflows/build.yml |
Adds a new CI job running the protocol/overlay bump check and makes complete depend on it. |
.github/workflows/build-private.yml |
Adds the same check job for the private workflow. |
sisuresh
force-pushed
the
protocol-overlay-version-check
branch
from
3ebbcc0 to
a2badb9
Compare
Contributor
Author
|
This PR only bumps the max overlay version, but we could also require updates to the min depending on a set criteria cc @marta-lokhova |
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
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.
Description
Adds a CI check that fails if
Config::CURRENT_LEDGER_PROTOCOL_VERSIONis bumped without also bumpingOVERLAY_PROTOCOL_VERSIONinsrc/main/Config.cpp.scripts/check-protocol-overlay-versions.shcompares both constants between the PR base and head (can also be run locally, e.g../scripts/check-protocol-overlay-versions.sh origin/master).protocol-version-checkjob inbuild.yml, wired into thecompletejob'sneedsso it blocks merges, and a matching standalone job inbuild-private.yml.Checklist
clang-formatv8.0.0 (make formator the Visual Studio extension)