docs(install): serve the install scripts and document installing - #62
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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 |
There was a problem hiding this comment.
Pull request overview
This PR makes the CLI’s “copy/paste install” experience real by hosting the versioned install/uninstall scripts on GitHub Pages (stable URLs without a branch name) and documenting both scripted and manual installation paths in the docs.
Changes:
- Added an Installation section to the top-level README with macOS/Linux/WSL and Windows commands plus supported platforms.
- Added a new installation guide covering scripted install/uninstall, manual download-and-verify install, version pinning, prereleases,
WSO2_HOME, and profile-edit opt-out. - Added a GitHub Actions Pages workflow to publish install/uninstall scripts (and a small landing page) from
main.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds the primary, stable install commands and a pointer to the full install guide. |
| docs/README.md | Links the new “Installing” guide from the documentation index. |
| docs/guides/installing.md | Introduces the end-to-end installation guide (scripted + manual + uninstall). |
| .github/workflows/pages.yml | Publishes install/uninstall scripts (and index.html) to GitHub Pages on main. |
Suppressed comments (2)
docs/guides/installing.md:150
- As with the other pipeline examples,
WSO2_CLI_NO_PROFILE=1here only applies tocurl, not tobashexecuting the installer. The installer won’t see the opt-out flag in the current form.
WSO2_CLI_NO_PROFILE=1 curl -fsSL https://wso2.github.io/wso2-cli/install.sh | bash
docs/guides/installing.md:137
- In this pipeline,
WSO2_HOME=/opt/wso2is only set forcurl, not forbashrunning the installer, so the install location won’t actually change. The env var needs to be set on thebashside (or exported before running the pipeline).
WSO2_HOME=/opt/wso2 curl -fsSL https://wso2.github.io/wso2-cli/install.sh | bash
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Closes #57. Last of the five, stacked on #61.
Publishes both install scripts and both uninstall scripts to GitHub Pages from main, so the command in the README carries no branch name and can be repointed at a WSO2-owned domain later without invalidating what users have already copied. Adds the installation guide and the README section.
This needs Pages enabled for the repository with GitHub Actions as its source, which is a repository setting and needs admin. Until it is switched on, the deploy step fails and the published URLs 404 — the release page and the manual verify-and-extract path in the guide still work. Everything else in this PR is independent of that switch.
The documented piped invocations were run against real artifacts rather than assumed: pinning through
bash -s v0.0.0and purging throughbash -s -- --purgeboth behave as written, and an install-then-uninstall round trip left the shell profile byte-for-byte as it started.