Repository navigation
fix(ci): the plugin API check compares a used function's signature, not only that it exists - #254
Open
AlexS-scale wants to merge 2 commits into
Open
AlexS-scale wants to merge 2 commits into
AlexS-scale wants to merge 2 commits into
Conversation
…ot only that it exists
This branch has not been deployed
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.
Follow-up to #234. The plugin API check passes each
USEDentry's old and new object togriffe.find_breaking_changes. griffe compares only an object's members, so for a function it reports nothing. Every function listed inUSEDby itself was checked only for existence: for example, makingcount_runs'stask_idrequired, or removing a parameter, passed without a!. That covers #234's run-index functions (insert_run,mark_terminal, …),find_task_instance,task_instances,build_env_providerandregister_env_instance. Functions reached through a module entry (agent_env.plugins.settings) were already checked.Now a function entry is compared through its parent module or class, and only its own breakages are kept.
The check still passes on
main. Tests: a newused-function-signature-changedcase fails before this change. Anunused-sibling-of-a-used-functioncase shows that changing a function in the same module that isn't on the surface still passes.

Confidence Score: 5/5
The PR appears safe to merge; the requested sibling-filtering test is now present.Summary
The PR makes the plugin API check catch signature changes to individually listed functions.
Reviews (2) · Last reviewed commit: "test(ci): a change to a used function's ..." · Reviewed by Greptile