Skip to content

docs: add conformance status badges - #657

Merged
zhongkechen merged 1 commit into
mainfrom
codex/conformance-badges
Aug 19, 2026
Merged

docs: add conformance status badges#657
zhongkechen merged 1 commit into
mainfrom
codex/conformance-badges

Conversation

@zhongkechen

Copy link
Copy Markdown
Contributor

Summary

  • add a README badge for the core conformance workflow
  • add a README badge for the OpenTelemetry conformance workflow

Testing

  • git diff --check
  • confirmed both workflow paths are active on main

@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime August 19, 2026 19:49 — with GitHub Actions Inactive
@zhongkechen
zhongkechen temporarily deployed to ai-pr-review-runtime August 19, 2026 19:49 — with GitHub Actions Inactive
@zhongkechen
zhongkechen merged commit de43971 into main Aug 19, 2026
14 checks passed
@zhongkechen
zhongkechen deleted the codex/conformance-badges branch August 19, 2026 20:57
Comment thread README.md
# AWS Durable Execution SDK for Python

[![Build](https://github.com/aws/aws-durable-execution-sdk-python/actions/workflows/ci.yml/badge.svg)](https://github.com/aws/aws-durable-execution-sdk-python/actions/workflows/ci.yml)
[![Core Conformance](https://github.com/aws/aws-durable-execution-sdk-python/actions/workflows/conformance-tests.yml/badge.svg)](https://github.com/aws/aws-durable-execution-sdk-python/actions/workflows/conformance-tests.yml)

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.

Claude AI review

The Core Conformance badge will render "no status" rather than a pass/fail state. GitHub status badges (with no ?branch=/?event= query) reflect the most recent run on the default branch (main), but conformance-tests.yml only triggers on pull_request and workflow_dispatch (.github/workflows/conformance-tests.yml:7-14) — it has no push: branches: [main] trigger. pull_request runs are attributed to the PR head branch, not main, so nothing populates the default-branch status. Contrast this with the working ci.yml badge and the OpenTelemetry badge added just below, both of whose workflows include push: branches: [main].

Concrete fix: add a push: branches: ["main"] trigger to conformance-tests.yml (matching opentelemetry-conformance-tests.yml) so the badge reflects real status. Note that the conformance workflow deploys to shared AWS stacks under a global concurrency lock, so if running it on every push to main is undesirable, prefer removing this badge (or replacing it with one that points at a workflow that does run on main) rather than shipping a badge that permanently shows "no status".

@github-actions

Copy link
Copy Markdown
Contributor

Codex AI review

No actionable findings. Both badge URLs match existing workflow filenames. Residual risk: live badge rendering and status responses were not network-validated.

Reviewed commit 67b1e84992bea4f87fb99c7c8aa1cdb83d3c05a1. Workflow run

@github-actions

Copy link
Copy Markdown
Contributor

Claude AI review

This PR adds two README conformance badges. Both referenced workflow files exist and both badge/link URLs are well-formed. The OpenTelemetry Conformance badge will work correctly because opentelemetry-conformance-tests.yml triggers on push: branches: ["main"].

One actionable issue: the Core Conformance badge (README line 4) points at conformance-tests.yml, which only triggers on pull_request and workflow_dispatch — it never runs on push to main. GitHub status badges show the most recent run on the default branch, and pull_request runs are attributed to the PR head branch (not main), so this badge will render "no status" and defeat its stated purpose. See the inline comment on README.md:4.

Residual test risk: none beyond the badge-rendering behavior noted above; this is a docs-only change and cannot be exercised by the repo's test suites (verified in CI only after merge to main).

Reviewed commit 67b1e84992bea4f87fb99c7c8aa1cdb83d3c05a1. Workflow run

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants