Skip to content

feat(coverage): cross-repo coverage installer options and coverage docs [2/4] - #8590

Closed
jainprad wants to merge 1 commit into
users/jainprad/coverage/pr1-buildfrom
users/jainprad/coverage/pr2-tooling
Closed

jainprad wants to merge 1 commit into
users/jainprad/coverage/pr1-buildfrom
users/jainprad/coverage/pr2-tooling

Conversation

@jainprad

@jainprad jainprad commented Sep 29, 2026 •

Copy link
Copy Markdown

Stack

Review and merge in order; each PR's diff shows only its own changes.

  1. build(coverage): add per-project code coverage build options [1/4] #8589 Build support for coverage
  2. feat(coverage): cross-repo coverage installer options and coverage docs [2/4] #8590 Coverage installer options and docs (this PR)
  3. ci(coverage): plumbing for the coverage build variant and test jobs [3/4] #8591 Plumbing for the coverage build and test jobs
  4. ci(coverage): add on-demand coverage workflows [4/4] #8592 On-demand coverage workflows

Based on #8589. Split out of #7783.

Motivation

Part 2 of 4 of the split of #7783 (code coverage): the coverage installer's cross-repo options, and the coverage documentation.

GitHub issue: #6572

Technical Details

  • build_tools/install_rocm_code_coverage_build.py: adds --code-coverage-run-github-repo and --code-coverage-release-type, so the instrumented replacement artifacts can be fetched from a different repository and S3 bucket than the baseline install. The instrumented build publishes to the ci bucket, while a baseline usually comes from a nightly. Uses the release_type override from part 1.
  • docs/development/code_coverage.md: new. Covers local instrumented builds, producing a report locally, and the coverage CI flow, whose workflows arrive in part 4.
  • docs/development/development_guide.md: documents {PROJECT}_ENABLE_COVERAGE.
  • docs/development/README.md and ci_overview.md: link the new docs.

Nothing on main calls install_rocm_code_coverage_build.py yet.

Test Plan

  • install_rocm_code_coverage_build_test.py: the instrumented fetch uses the coverage run's repository, not the baseline's, and defaults to $GITHUB_REPOSITORY.
  • artifact_backend_test.py.
  • pre-commit (including mdformat) on the changed files.

Test Result

All of the above pass locally.

Submission Checklist

- install_rocm_code_coverage_build.py: --code-coverage-run-github-repo and
  --code-coverage-release-type, so the instrumented replacement artifacts
  can be fetched from a different repository and S3 bucket than the
  baseline install. Uses the release_type override added to
  create_backend_from_env().
- docs: add code_coverage.md (local builds, local reports, and the coverage
  CI flow), document {PROJECT}_ENABLE_COVERAGE in the development guide, and
  link both from the docs index and the CI overview.

Split out of #7783.

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant