Enhance pick_experiment.cjs step summary with description and issue link#29627
Enhance pick_experiment.cjs step summary with description and issue link#29627
Conversation
…ssue link Agent-Logs-Url: https://github.com/github/gh-aw/sessions/4c6accc2-63bf-4b4d-b4e9-3d21ba22a04b Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Enhances the pick_experiment.cjs step summary so engineers can see experiment purpose and tracking context (description + tracking issue link) directly in the workflow run summary.
Changes:
- Extend
writeSummaryto optionally append an “Experiment Details” section with description (blockquote) and a tracking issue link derived fromGITHUB_REPOSITORY. - Add unit tests covering description-only, issue-only, both fields, legacy bare-array behavior, and missing-
GITHUB_REPOSITORYfallback.
Show a summary per file
| File | Description |
|---|---|
| actions/setup/js/pick_experiment.cjs | Appends optional experiment metadata (description + issue link) to the step summary. |
| actions/setup/js/pick_experiment.test.cjs | Adds tests validating the new summary rendering and backward compatibility. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 1
| if (description) { | ||
| lines.push(""); | ||
| lines.push(`> ${description}`); | ||
| } |
🧪 Test Quality Sentinel ReportTest Quality Score: 72/100
Test Classification DetailsView all 5 test classifications
Flagged Tests — Suggestions for ImprovementNo tests were classified as implementation tests. The following are improvement suggestions rather than blocking issues:
|
The
pick_experiment.cjsstep summary only surfaced variant assignment counts, leaving engineers to dig into workflow YAML to understand experiment purpose and tracking context.Changes
actions/setup/js/pick_experiment.cjs: ExtendedwriteSummaryto append a### Experiment Detailssection when any experiment declaresdescriptionorissuemetadata. Per experiment: bold name,> {description}blockquote, andTracking issue: [#N](https://github.com/{repo}/issues/N)link (viaGITHUB_REPOSITORYenv var; falls back to plain#Nif unset). No output change for bare-array experiments — fully backward-compatible.actions/setup/js/pick_experiment.test.cjs: Five new tests covering description-only, issue-only, both fields, legacy bare-array (no extras emitted), and missing-GITHUB_REPOSITORYfallback.Example output (object-form experiment with both fields)