-
Notifications
You must be signed in to change notification settings - Fork 569
feat: add api check to github workflow #1348
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
afarntrog
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you have an action with a successful run?
yes, updated local result |
zastrowm
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to @afarntrog's comment, can you create a fake PR in your fork to see what the end result is?
I think if you:
- Create a branch off of an old commit
- Add this workflow
- Create a PR from that branch to your own main
Then I think we'd be able to see this in the PR itself.
fix package name.
… on push, rather than the latest tag
aba1a02 to
6fef1fa
Compare
Description
This Pr add api check ( breaking change detection ) workflow to github, integrating to exsiting PR process.
This feature only detects public api change.
This is referenced from https://mkdocstrings.github.io/griffe/guide/users/checking/
Run this workflow in my fork:
https://github.com/JackYPCOnline/sdk-python/actions/runs/20383382911/job/58578997251
^ In this PR, I added a parameter to public function.
also run compared with current tag with command : uvx griffe check --search src --format github strands
no diff.
Related Issues
Hack week
Documentation PR
Type of Change
Bug fix
New feature
Breaking change
Documentation update
Other (please describe):
Testing
How have you tested the change? Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli
hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.