sgl-project/sglang

[CI] Print nightly evaluation results to GITHUB_STEP_SUMMARY

Closed

#2,275 opened on Nov 30, 2024

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Python (6,216 forks)auto 404
good first issuehelp wanted

Repository metrics

Stars
 (28,442 stars)
PR merge metrics
 (Avg merge 2d 1h) (1,000 merged PRs in 30d)

Description

We would like to to have a nicer summary page on the nightly evaluation results. The summary should include the scores and thresholds of all models in a markdown table.

An example run: https://github.com/sgl-project/sglang/actions/runs/12060420843

Steps

  1. Learn GITHUB_STEP_SUMMARY at https://github.blog/news-insights/product-news/supercharging-github-actions-with-job-summaries/
  2. Print a summary of the nightly eval to GITHUB_STEP_SUMMARY

See also an example https://github.com/sgl-project/sglang/pull/2274

Contributor guide

Research direction
Review the nightly eval.yml workflow file and learn to output a markdown table with scores and thresholds to GITHUB STEP SUMMARY.
Tech stack
pythongithub actions
Domain
ci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75