Simplify the README and link the latest smoke results - #47
Conversation
Co-authored-by: Grok 4.7 <noreply@x.ai>
|
Warning Review limit reachedNext included review available in 50 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5ef6e861bd
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| | Lane | Run | Coverage | | ||
| | --- | --- | --- | | ||
| | Packages | `just smoke`, `just full` | Published clients through a local `moq-relay`. `smoke` is Rust only. `full` is the cross-language matrix. | | ||
| | Public relays | `just relays` | The same clients through every relay in the [moq-interop-runner](https://github.com/englishm/moq-interop-runner) registry. This lane is what the [results page](https://moq-dev.github.io/smoke/) shows. Only `--required` relays fail the run; the default is moq-dev's `cdn.moq.dev`. | |
There was a problem hiding this comment.
When readers invoke the documented just relays, relays.sh passes no client axes, so smoke.sh defaults to only the rust publisher and subscriber; even CI uses only rust/browser publishers and rust/browser/bun subscribers, not the full package matrix. Calling these “the same clients” overstates the coverage and can make an external-relay experiment appear to cover Python, Go, Swift, Kotlin, C, and GStreamer when none ran. State the default and CI subsets explicitly.
Useful? React with 👍 / 👎.
| just full # full matrix, --timeout 30 | ||
| # Cloudflare client/relay self-test + Cloudflare client against moq-dev relay: | ||
| nix develop | ||
| cargo install moq-relay moq-cli # or brew, apt, just nix-channel, clients/docker |
There was a problem hiding this comment.
When a user chooses the suggested just nix-channel alternative, the recipe in justfile:63-76 builds with --no-link and immediately runs smoke.sh; it does not install either binary or leave it on PATH, so the following just full still fails its binary checks. clients/docker is likewise a pair of wrappers that must be supplied via RELAY_BIN and MOQ_BIN, not an install command. Show these as alternative ways to run the matrix rather than substitutes for the installation line.
AGENTS.md reference: AGENTS.md:L33-L35
Useful? React with 👍 / 👎.
just relays defaults to the Rust publisher and subscriber. CI publishes with Rust and the browser and subscribes with Rust, the browser, and js-bun. just nix-channel builds with --no-link and runs smoke.sh; it does not install onto PATH. The docker wrappers are RELAY_BIN and MOQ_BIN, not an install. Co-authored-by: Grok 4.7 <noreply@x.ai>
|
Landed on main as b0f6f35. The README now leads with the results page and keeps the lanes, the client table, and how to run them. Both review notes were still true, so the page now says:
#48 and #41 also edit README.md and need a rebase onto this. (written by Grok 4.7) |
1 participant
The README had grown into a status log. The nightly relay report is the place for current results, so the page leads and the rest is the lanes, the clients, and how to run them.
(written by Grok 4.7)