Move list of instrumentations to top level readme, generate it - #351
Open
lmolkova wants to merge 3 commits into
Open
Move list of instrumentations to top level readme, generate it#351lmolkova wants to merge 3 commits into
lmolkova wants to merge 3 commits into
Conversation
Pull request dashboard statusWaiting on reviewers · refreshed 2026-08-05 04:09 UTC Review the latest changes. Status above doesn't look right?
|
Contributor
There was a problem hiding this comment.
Pull request overview
Moves the instrumentation inventory to the repo’s top-level README.md and updates automation so the list is generated/kept current as part of the release flow.
Changes:
- Update
scripts/generate_instrumentation_readme.pyto generate released vs unreleased instrumentation tables and inject them intoREADME.mdbetween marker comments. - Remove the stale
instrumentation/README.mdand add a release-finalize step to regenerate the top-level README section. - Align dev versions for several unreleased instrumentations to
1.1b0.dev.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| scripts/generate_instrumentation_readme.py | Generates released/unreleased instrumentation tables and injects them into the root README; cleans up old instrumentation README. |
| README.md | Adds an auto-generated instrumentations section (bounded by markers) to be maintained by the generator. |
| instrumentation/README.md | Removes the now-obsolete instrumentation list file. |
| instrumentation/opentelemetry-instrumentation-genai-weaviate-client/src/opentelemetry/instrumentation/genai/weaviate_client/version.py | Bumps dev version to 1.1b0.dev. |
| instrumentation/opentelemetry-instrumentation-genai-qwen-agent/src/opentelemetry/instrumentation/genai/qwen_agent/version.py | Bumps dev version to 1.1b0.dev. |
| instrumentation/opentelemetry-instrumentation-genai-claude-agent-sdk/src/opentelemetry/instrumentation/genai/claude_agent_sdk/version.py | Bumps dev version to 1.1b0.dev. |
| .github/workflows/_release-finalize.yml | Runs the README generator during release finalization. |
Suppressed comments (1)
scripts/generate_instrumentation_readme.py:137
main()treats any non-"skeleton" result as released. With the suggested non-fatal PyPI error handling (returning "unknown"), packages would incorrectly show up as released on transient failures. Handle an "unknown" PyPI status explicitly (keep it in the unreleased table with a clear status message) so the README doesn't misrepresent publish state.
status = get_pypi_status(instrumentation)
if status == "skeleton":
if instrumentation in release_workflow_packages:
unreleased_status = "to be released"
else:
unreleased_status = "skeleton"
unreleased_rows.append(
f"| [{instrumentation}](./instrumentation/{instrumentation}) | {','.join(instruments_all)} | {local_version} | {unreleased_status} |"
)
# Conflicts: # instrumentation/README.md
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.
the https://github.com/open-telemetry/opentelemetry-python-genai/blob/2cabe194d88cedd8b700f778ade3e8dd8e60cd4f/instrumentation/README.md is out of date
This PR