Skip to content

Move list of instrumentations to top level readme, generate it - #351

Open
lmolkova wants to merge 3 commits into
open-telemetry:mainfrom
lmolkova:generate-instrumentations-list
Open

Move list of instrumentations to top level readme, generate it#351
lmolkova wants to merge 3 commits into
open-telemetry:mainfrom
lmolkova:generate-instrumentations-list

Conversation

@lmolkova

@lmolkova lmolkova commented Aug 3, 2026

Copy link
Copy Markdown
Member

the https://github.com/open-telemetry/opentelemetry-python-genai/blob/2cabe194d88cedd8b700f778ade3e8dd8e60cd4f/instrumentation/README.md is out of date

This PR

  • moves it to top-level readme
  • updates to script to generate it
  • separates the list into released and not released libs (not released have a special marker 'skeleton' if they're not mentioned in release workflows)

@opentelemetry-pr-dashboard

opentelemetry-pr-dashboard Bot commented Aug 3, 2026

Copy link
Copy Markdown

Pull request dashboard status

Waiting on reviewers · refreshed 2026-08-05 04:09 UTC

Review the latest changes.

Status above doesn't look right?
  • Just replied or pushed? Anything around or after the refresh time above may not be picked up yet — give it a few minutes.
  • Anything look wrong? Report it with what you expected; it helps us improve the dashboard.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.py to generate released vs unreleased instrumentation tables and inject them into README.md between marker comments.
  • Remove the stale instrumentation/README.md and 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} |"
            )

Comment thread scripts/generate_instrumentation_readme.py
# Conflicts:
#	instrumentation/README.md
@lmolkova lmolkova added the Skip Changelog PR does not require a changelog entry label Aug 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog PR does not require a changelog entry

Development

Successfully merging this pull request may close these issues.

2 participants