Skip to content

Spec design for GitHub Pages report publication #103

@aryeko

Description

@aryeko

Motivation

The publication policy designates results/latest/report.md and results/latest/summary.json as the primary benchmark artifacts. Currently these are only accessible by cloning the repository. Publishing via GitHub Pages would:

  • Make benchmark results browsable without cloning.
  • Provide a professional, linkable homepage for the project.
  • Enable embedding results in external documentation or blog posts.

Goal

Publish benchmark reports and summaries via GitHub Pages with automated deployment.

Requirements

  • Deployment source: Deploy from a gh-pages branch, populated by CI after each benchmark run or report generation.
  • Content: At minimum, serve report.md rendered as HTML and summary.json as a downloadable artifact.
  • Branded landing page: Include project branding consistent with go-modkit/modkit social assets.
  • Homepage URL update: Once Pages is live, update the repository homepage URL to point to the published site instead of the modkit repo.
  • CI integration: Add a deployment step to the benchmark or report workflow that pushes to gh-pages.
  • Custom domain (optional): Evaluate whether a custom domain (e.g., benchmarks.modkit.dev) is warranted.

Open questions

  • Should historical reports be preserved (versioned pages) or only show latest?
  • Should the landing page include a comparison table or just link to the full report?
  • What static site generator (if any) should be used — plain markdown rendering, Jekyll, or a lightweight alternative?

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: reportReport generation and publicationpriority: mediumNormal prioritytype: specSpecification or design document

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions