Skip to content

docs: add curl | bash install and release guide#20

Merged
ClayMav merged 1 commit into
mainfrom
docs/curl-install-and-release-guide
Apr 24, 2026
Merged

docs: add curl | bash install and release guide#20
ClayMav merged 1 commit into
mainfrom
docs/curl-install-and-release-guide

Conversation

@ClayMav
Copy link
Copy Markdown
Member

@ClayMav ClayMav commented Apr 24, 2026

Summary

  • Add a curl | bash one-liner to the README's Installation section pointing at scripts/install-release.sh on main; show a bash -s -- variant for passing flags like --install-dir / --tag.
  • Drop the gh CLI prerequisite from the README — the installer now resolves latest via the GitHub releases API (PR fix: resolve latest to actual release tag before downloading #18) and no longer shells out to gh.
  • Add RELEASE.md covering both release channels (rolling latest-prerelease on every push to main, and tagged stable vX.Y.Z via git push origin vX.Y.Z), since the process previously lived only in workflow YAML. Includes version-picking guidance, a note-preview command, and recovery steps.
  • Link RELEASE.md from the README's Development section.

Test plan

  • Confirm the raw scripts/install-release.sh URL (https://raw.githubusercontent.com/wherobots/wbc-cli/main/scripts/install-release.sh) returns 200 once this branch is merged.
  • Spot-check the curl | bash one-liner on macOS and Linux after merge.
  • Verify RELEASE.md renders correctly on GitHub.

Adds a `curl | bash` one-liner to the README's Installation section
so users don't need to clone the repo to install. Drops the stale
`gh` CLI prerequisite (the installer now uses the GitHub releases
API directly).

Adds RELEASE.md documenting both release channels (rolling
`latest-prerelease` and tagged stable `vX.Y.Z`), since the process
previously lived only in workflow YAML.
@ClayMav ClayMav marked this pull request as ready for review April 24, 2026 18:48
@ClayMav ClayMav requested a review from a team as a code owner April 24, 2026 18:48
@ClayMav ClayMav requested a review from haizhou-zhao April 24, 2026 18:48
@ClayMav ClayMav merged commit 6829e30 into main Apr 24, 2026
1 check passed
@ClayMav ClayMav deleted the docs/curl-install-and-release-guide branch April 24, 2026 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants