Skip to content

Add experiment results to GitHub job summaries #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joshblack merged 1 commit into from
May 28, 2026
Merged

Add experiment results to GitHub job summaries #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion packages/agent-eval/src/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import type {Treatment, TreatmentResult} from './treatment'
import {run} from './run'

const COPILOT_GITHUB_TOKEN = process.env.COPILOT_GITHUB_TOKEN
const GITHUB_STEP_SUMMARY = process.env.GITHUB_STEP_SUMMARY

if (!COPILOT_GITHUB_TOKEN) {
throw new Error('COPILOT_GITHUB_TOKEN environment variable is required to run the experiments')
Expand Down Expand Up @@ -335,6 +336,14 @@ function formatResultSummaries(results: Array<TreatmentResult>): string {
return formatTable(rows, columns)
}

async function appendResultsToJobSummary(resultSummaries: string) {
if (!GITHUB_STEP_SUMMARY) {
return
}

await fs.appendFile(GITHUB_STEP_SUMMARY, `## Experiment results\n\n\`\`\`\n${resultSummaries}\n\`\`\`\n`)
}

function formatSummaryRow(summary: ResultSummary, level: 'treatment' | 'eval' | 'model'): TableRow {
return {
Experiment: level === 'treatment' ? summary.experiment : '',
Expand Down Expand Up @@ -392,6 +401,8 @@ for (const config of experimentConfigs) {
}

const sortedResults = results.toSorted(compareResults)
console.log(formatResultSummaries(sortedResults))
const resultSummaries = formatResultSummaries(sortedResults)
console.log(resultSummaries)
await appendResultsToJobSummary(resultSummaries)

await fs.writeFile('results.json', JSON.stringify(sortedResults, null, 2))