feat: add backward compatibility tests for run.yaml #3952
Merged
+627
−0
Conversation
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
Add automated testing to catch breaking changes to StackRunConfig before they reach users. - Schema validation: pytest-based test validates old run.yaml files parse with current StackRunConfig - Integration tests: run full test suite with old ci-tests run.yaml to catch runtime semantic issues - Dual baseline: test against both main (blocks PRs) and latest release (informational) - Breaking change acknowledgment: require '!:' in PR title or 'BREAKING CHANGE:' in commit message to merge breaking changes Resolves llamastack#3311 Related to llamastack#3237
ashwinb
requested review from
bbrowning,
ehhuang,
franciscojavierarceo,
hardikjshah,
leseb,
mattf,
raghotham,
reluctantfuturist,
slekkala1,
terrytangyuan and
yanxi0830
as code owners
meta-cla
bot
added
the
CLA Signed
|
yay? 
|
|
This is awesome, thank you. I had something similar in #3543 but this is more comprehensive. will close in favor of this one!! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This adds automated backward compatibility testing for
run.yamlfiles. As we evolveStackRunConfig, changes can inadvertently break existing user configurations. This workflow catches those breaks before merge.We test old run.yaml files (from main and the latest release) against the PR's new code. If configs that worked before now fail, the PR is blocked unless explicitly acknowledged as a breaking change.
Two test layers:
What we test against:
If tests fail, the PR author must acknowledge the breaking change by adding
!:to the PR title (e.g.,feat!: change xyz) or includingBREAKING CHANGE:in a commit message. Once acknowledged, the check passes with a warning.These jobs are run:
check-main-compatibility- Schema validation of all distribution run.yaml files from maintest-integration-main- Full integration test suite using main's ci-tests run.yamltest-integration-release- Integration tests with latest release config (informational)check-schema-release-compatibility- Schema checks against release (informational)The integration tests catch issues that schema validation alone would miss, like assertion failures in
StackRunConfig.validate_server_stores()or provider-specific runtime logic.Resolves #3311
Related to #3237