Skip to content

Conversation

@JackYPCOnline
Copy link
Contributor

@JackYPCOnline JackYPCOnline commented Dec 16, 2025

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

  • I ran hatch run prepare

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@JackYPCOnline JackYPCOnline marked this pull request as ready for review December 16, 2025 19:10
@codecov
Copy link

codecov bot commented Dec 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Contributor

@afarntrog afarntrog left a 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?

@JackYPCOnline
Copy link
Contributor Author

JackYPCOnline commented Dec 16, 2025

Do you have an action with a successful run?

yes, updated local result

afarntrog
afarntrog previously approved these changes Dec 16, 2025
Copy link
Member

@zastrowm zastrowm left a 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.

zastrowm
zastrowm previously approved these changes Dec 22, 2025
@JackYPCOnline JackYPCOnline merged commit ad2f201 into strands-agents:main Dec 23, 2025
14 of 15 checks passed
@JackYPCOnline JackYPCOnline deleted the api-check branch December 23, 2025 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants