README: add a short description of the architecture - #38
Open
marten-seemann wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the repository README with a brief architecture overview of how repeatable benchmark runs are achieved via prebuilt runner images, and adds a “Workflows” section to point readers to the key GitHub Actions pipelines.
Changes:
- Adds a short description of how prebuilt cloud runner images are used to create ephemeral benchmark nodes.
- Introduces a “Workflows” section linking to
packer.yml,benchmark.yml, andcleanup.ymlwith a one-line purpose each.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Workflows | ||
|
|
||
| - [`.github/workflows/packer.yml`](.github/workflows/packer.yml) builds new runner images and uploads them to AWS, GCP and Azure. |
| ## Workflows | ||
|
|
||
| - [`.github/workflows/packer.yml`](.github/workflows/packer.yml) builds new runner images and uploads them to AWS, GCP and Azure. | ||
| - [`.github/workflows/benchmark.yml`](.github/workflows/benchmark.yml) creates temporary server and client nodes, runs the selected benchmark. |
marten-seemann
force-pushed
the
readme-architecture
branch
from
June 20, 2026 09:49
6418db1 to
36eeb01
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add architecture overview and workflow descriptions to README
Expands README.md with a brief architecture overview explaining how runner images are built with quic-go/perf and MsQuic, and how benchmarks run on short-lived server/client nodes. Adds a new 'Workflows' section linking to and describing the packer, benchmark, and cleanup workflow files.
Macroscope summarized 36eeb01.