Add HTML report as an output format option for benchmark subcommand

Open
#296 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
html, rust
Domain
cli, performance

Research direction

Start by locating the benchmark subcommand, the existing output-format machinery, and the current HTML report implementation. Determine how HTML can be exposed through sightglass benchmark --output-format html; done means the command produces the existing HTML report through the standard output-format option.

Written by the indexing model from the issue text.

Description

https://github.com/bytecodealliance/sightglass/pull/295#pullrequestreview-3589220910

Not something we need to do now but it would be cool to integrate the HTML reports into our existing output format machinery, rather than (or in addition to) having it be a separate CLI subcommand, so we could just do something like

$ sightglass benchmark --output-format html ...
Dominant language
WebAssembly
Stars
88
Forks
37
Avg merge
5h 5m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from bytecodealliance/sightglass

All issues in bytecodealliance/sightglass

Similar issues

More CLI issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.