Conversation
Pull request dashboard statusWaiting on the author · refreshed 2026-10-04 17:34 UTC Investigate required status check failures. Status above doesn't look right?
|
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The hardcoded main baseline causes false failures for PRs targeting release branches.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Adds automated compatibility checking for the util-genai public API.
Changes:
- Adds a pinned Griffe dependency and tox environment.
- Runs the API check in CI with a maintainer-label bypass.
- Documents the workflow for contributors and reviewers.
| File | Description |
|---|---|
tox.ini |
Defines the Griffe API check. |
dev-requirements.txt |
Pins Griffe 2.3.0. |
AGENTS.md |
Documents local API compatibility checks. |
.github/workflows/misc.yml |
Adds the CI job. |
.github/instructions/util-genai.instructions.md |
Adds review guidance for API changes. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| -c {toxinidir}/dev-requirements.txt | ||
| griffe | ||
| commands = | ||
| griffe check opentelemetry.util.genai -s util/opentelemetry-util-genai/src -a origin/main |
Assisted-by: ChatGPT
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.
Adds a
check-util-apiCI job. It runsgriffe checkon util-genai against main and fails if a public object is removed or its signature changes. It mirrorspublic-symbols-checkin opentelemetry-python core, and theApprove Public API checklabel skips it.Released instrumentations accept any util version below 2. #823 removes
get_telemetry_handler, which langchain 1.0b0, 1.1b0, 1.1b1 and openai-agents 1.0b0, 1.1b0 import at module level. With the next util release they would fail on import. This job catches that kind of break.Known gaps:
Approve Public API checklabel doesn't exist in this repo yet.AgentInvocation.agent_idmoved to the remote agent subclass. I haven't checked yet whether they affect old releases.