Skip to content

Update OTel GenAI conventions skill for standalone semconv-genai repo#7519

Open
jeffhandley wants to merge 2 commits intodotnet:mainfrom
jeffhandley:otel-repo-move
Open

Update OTel GenAI conventions skill for standalone semconv-genai repo#7519
jeffhandley wants to merge 2 commits intodotnet:mainfrom
jeffhandley:otel-repo-move

Conversation

@jeffhandley
Copy link
Copy Markdown
Member

@jeffhandley jeffhandley commented May 8, 2026

The OpenTelemetry GenAI semantic conventions moved from open-telemetry/semantic-conventions (under area:gen-ai) to a dedicated repo, open-telemetry/semantic-conventions-genai. The new repo also hosts mcp, openai, anthropic, aws-bedrock, and azure-ai-inference areas, has no releases yet (CHANGELOG Unreleased is the live view), no area: labels (every PR is in scope), and a GenAI-namespaced schema URL (opentelemetry.io/schemas/gen-ai/X.Y.Z) independent of core semconv.

Changes (skill-only, no source code edits).

After applying these changes to the skill, a re-run of the skill to audit for any changes necessary correctly determined no changes are needed at this time.

Microsoft Reviewers: Open in CodeFlow

The OpenTelemetry GenAI semantic conventions moved from
open-telemetry/semantic-conventions (under area:gen-ai) to a dedicated
repo, open-telemetry/semantic-conventions-genai. The new repo also
hosts mcp, openai, anthropic, aws-bedrock, and azure-ai-inference
areas, has no releases yet (CHANGELOG Unreleased is the live view), no
area: labels (every PR is in scope), and a GenAI-namespaced schema URL
(opentelemetry.io/schemas/gen-ai/X.Y.Z) independent of core semconv.

Changes (docs-only, no source code edits):

- SKILL.md: new Migration Note + Cross-repo applicability sections;
  rewritten Input Handling for 4 input shapes (PR refs, CHANGELOG
  snapshot, date range, releases); In-scope areas table with concrete
  external repo references; broadened search terms in PR Preflight,
  Mode 1 spec, Mode 2/3/5; Gotchas updated with transitional version-
  reference grep regex and area-aware constants bullet.

- references/file-inventory.md: pre/post-migration doc-comment wording,
  transitional grep regex, Provider-specific instrumentation table.

- references/historical-releases.md: Migration Note prepended; pointers
  to new repo CHANGELOG/releases/PRs.

- references/change-classification.md: Areas section; Area column added
  to audit and PR-description tables; example anthropic row reflects
  cross-repo flagging.

- references/implementation-patterns.md: Area placement guidance
  callout; Pattern 6 rewritten with pre/post wording and one-shot
  migration guidance.

- references/implementation-procedure.md: area-aware nested class bullet.

- references/review-checklist.md: §6 transitional grep + wording-
  migration bullet; §7 area-aware nesting; §8 provider-scope bullet
  with cross-repo case.

- references/prompt-template.md: 4-input-shape Background block; Area
  column in audit table; cross-repo flagging guidance.

- references/pr-description.md: title clarifies independent GenAI
  version; Area column in PR table; old-repo catch-up linkage.

- references/testing-guide.md: Per-area test files section.

For provider-specific areas not instrumented in dotnet/extensions
(anthropic, aws-bedrock), the skill can be applied in the corresponding
SDK repos: anthropics/anthropic-sdk-csharp and the BedrockRuntime
service library of aws/aws-sdk-net.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the update-otel-genai-conventions Copilot skill documentation to reflect the OpenTelemetry GenAI semantic conventions migration from open-telemetry/semantic-conventions (area-labeled) to the standalone open-telemetry/semantic-conventions-genai repository, including expanded provider-area scope and GenAI-specific versioning.

Changes:

  • Added a migration note and updated input-handling guidance to support PRs, CHANGELOG.md snapshots, and date ranges from semantic-conventions-genai.
  • Introduced “area-aware” routing guidance (gen-ai vs mcp vs provider-specific areas) across the skill docs, templates, and checklists.
  • Updated prompt/template and PR-description guidance to include an Area column and repo-disambiguated references.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
.github/skills/update-otel-genai-conventions/SKILL.md Reorients the skill to semantic-conventions-genai, adds migration/cross-repo context, expands supported inputs.
.github/skills/update-otel-genai-conventions/references/testing-guide.md Adds guidance on keeping tests grouped by client while accounting for upstream “area” differences.
.github/skills/update-otel-genai-conventions/references/review-checklist.md Updates checklist to include wording-migration and provider/package scoping checks.
.github/skills/update-otel-genai-conventions/references/prompt-template.md Updates the CCA prompt template for new input types and adds an Area column.
.github/skills/update-otel-genai-conventions/references/pr-description.md Adjusts PR title/description format to GenAI versioning and adds Area column to the table shape.
.github/skills/update-otel-genai-conventions/references/implementation-procedure.md Adds guidance for area-aware constant placement and wording-migration handling.
.github/skills/update-otel-genai-conventions/references/implementation-patterns.md Adds “area placement guidance” section describing where changes should land by upstream area.
.github/skills/update-otel-genai-conventions/references/historical-releases.md Clarifies historical entries are pre-migration and points to new repo activity sources.
.github/skills/update-otel-genai-conventions/references/file-inventory.md Adds doc-comment wording migration guidance and provider-specific routing notes.
.github/skills/update-otel-genai-conventions/references/change-classification.md Extends classification to multi-area + non-release inputs and updates table shapes to include Area.

Comment thread .github/skills/update-otel-genai-conventions/references/change-classification.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Member

@tarekgh tarekgh left a comment

Choose a reason for hiding this comment

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

A few minor observations:

  1. Point-in-time version examples in the Migration Note: The inline examples 1.42.0 (gen-ai) and v1.41.0 (core semconv) with "at the time of writing" will silently go stale. Since X.Y.Z is already used as the general placeholder everywhere else, consider dropping the concrete versions or pinning them with a date (e.g. "as of May 2026") so a future reader knows how old the snapshot is.

  2. "No releases yet" qualifier: The bullet "No releases yet in the new repo (as of this writing)" lives in a durable skill file, not a PR description. Once semantic-conventions-genai ships its first release this will become inaccurate. A <!-- TODO: remove once first release ships --> marker (or similar) would make the staleness self-evident when it happens.

  3. implementation-procedure.md step 3, second sub-bullet: The new "Choose the correct constant location…" guidance packs a lot into one paragraph (five area categories, a concrete OpenAIClientExtensions.cs example, and the "introduce a file/class explicitly" rule). Breaking it into a mini-list or referencing the existing area-placement table in implementation-patterns.md instead of restating the rules inline might make it easier to scan during implementation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants