Repository navigation
Docs: Document the installer at www.rossoctl.dev - #1397
Conversation
rossoctl/.github#130 serves scripts/install.sh at https://www.rossoctl.dev/cortex/install.sh, synced from main on every site deploy. Make that the documented one-liner: install.sh's header and --help, the README quick start, CONTRIBUTING's release-candidate example, agentop's "nothing is installed" fix, the release notes, and the README animation (regenerated from demo.yaml). The raw.githubusercontent.com URL stays in the README as the one alternate, and wherever the repo must not depend on the site being current: install.sh's own re-exec fetches and its no-setup recovery hint, and CONTRIBUTING's --ref=main example, which runs the piped copy itself and so would run the site's possibly day-old one. agentop's one-liner also stops naming authbridge/install.sh, which only worked through the v0.7.0 redirect script. Refs rossoctl#1354 Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com> Signed-off-by: Ed Snible <snible@us.ibm.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation |
|---|---|---|
| Description Check | Check skipped - CodeRabbit’s high-level summary is enabled. | |
| Title check | The title clearly identifies the primary change: documenting the installer at www.rossoctl.dev. It is concise, specific, and related to the updated installation instructions. | |
| Docstring Coverage | Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (4 skipped: 4 … | |
| Linked Issues check | Check skipped because no linked issues were found for this pull request. | |
| Out of Scope Changes check | Check skipped because no linked issues were found for this pull request. |
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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 @coderabbitai help to get the list of available commands.
mrsabath
left a comment
There was a problem hiding this comment.
Mechanical URL swap across 7 files, backed by infrastructure that is already merged and verifiably live. The interesting work here is the restraint: every retained raw.githubusercontent.com reference has a specific reason tied to the site's resync cadence, and I checked each one against the actual code path rather than taking the description's word for it.
What I verified
| Claim | Result |
|---|---|
www.rossoctl.dev/cortex/install.sh is live |
200, application/x-sh, 64952 bytes — byte-identical to pre-PR scripts/install.sh |
rossoctl/.github#130 serves it |
Merged, Docusaurus postBuild plugin copies cortex/ to build/cortex/ |
| Sync cadence justifies the kept raw URLs | Deploy triggers are push-to-site, docs-updated dispatch from rossoctl/rossoctl, and a daily 06:17 UTC cron — nothing fires from rossoctl/cortex, so the site can lag main by up to ~24h |
--ref=main correctly kept on raw (CONTRIBUTING.md:116) |
That path short-circuits the re-exec (install.sh:438-445) and runs the piped copy itself — from the site it would run a possibly day-old script |
--ref=v0.9.0-rc.1 safely moved to www (CONTRIBUTING.md:218) |
Re-execs into the pinned ref from raw, so the entry point is irrelevant |
| Re-exec and legacy fallbacks untouched | All three probe URLs (scripts/, root, authbridge/) still raw; install_test.sh unchanged |
authbridge/install.sh drop in setup_step_binaries.go |
That path only resolved via the v0.7.0 redirect; the re-exec still probes it as a legacy fallback, so nothing regresses |
| SVG is a genuine regen, not hand-edited | All 76 changed lines are CSS keyframe timing (91 to 60 steps, 764.4px to 504.0px — consistent with the shorter URL) plus the rendered text; zero raw.githubusercontent left in it |
| No missed references | release-binaries.yaml fully converted. scripts/release_smoke_test_linux.sh correctly left on raw — it pins TRIGGER_SHA, which only raw can serve, and CI must test the repo's own copy |
The --ref=main-vs---ref=<tag> asymmetry in CONTRIBUTING.md looks inconsistent at a glance but is precisely correct given that only the former bypasses the re-exec. The README fallback note is a good addition — it keeps the repo self-sufficient when the site is unreachable, which is the same instinct driving the retained raw URLs.
Follow-up already flagged in the description, noted here so it is not lost: rossoctl/rossoctl docs/get-started/laptop.md:30 still has the raw URL, and the comment at README.md:19-21 exists precisely because these two drift.
Areas reviewed: Shell, Go, YAML, Docs, CI workflows, generated SVG
Commits: 1, signed-off: yes
CI status: passing (28/28; Spellcheck skipped by path filter)
Verified against 07a5930 throughout. LGTM.
Follow-up to #1354. rossoctl/.github#130 now serves
scripts/install.shathttps://www.rossoctl.dev/cortex/install.sh(synced frommainon every site deploy), so this makes it the documented one-liner.Moved to the www URL
scripts/install.sh: the header comment and--helpREADME.md: Quick startCONTRIBUTING.md: the release-candidate example (--ref=v0.9.0-rc.1)cmd/agentop/setup_step_binaries.go:installerOneLiner, the fixagentop setup/doctorprint when nothing is installed. This also drops the oldauthbridge/install.shpath, which only worked through the v0.7.0 redirect script..github/workflows/release-binaries.yaml: the install lines in the prerelease andmain-latestrelease notesscripts/readme-demo/demo.yaml, plusdocs/assets/cortex-demo.svgregenerated from it withgo run .Kept on
raw.githubusercontent.com: the repo should not depend on the site being current.README.mdnames it once, as the alternate if rossoctl.dev is unreachable.install.sh's re-exec fetches, which--refpinning and the legacy-path fallbacks rely on, and its no-setuprecovery hint.install_test.shis unchanged.CONTRIBUTING.md's "Installing an unreleased build" (--ref=main) example.--ref=mainruns the piped copy itself rather than re-execing, so piped from the site it would run the site's copy, which can lagmain.The website's laptop quickstart (
rossoctl/rossoctl,docs/get-started/laptop.md) will be updated separately.Testing
sh scripts/install_test.sh: 239 passed, 0 failedcmd/agentop:go vet ./...andgo test ./...passscripts/readme-demo:go test ./...passes, including the staleness check againstdemo.yamlAssisted-By: Claude (Anthropic AI) noreply@anthropic.com
Summary by CodeRabbit