Skip to content

docs(install): serve the install scripts and document installing - #62

Merged
kanushka merged 4 commits into
feat/uninstall-issue-56from
feat/install-docs-issue-57
Aug 11, 2026
Merged

docs(install): serve the install scripts and document installing#62
kanushka merged 4 commits into
feat/uninstall-issue-56from
feat/install-docs-issue-57

Conversation

@kanushka

Copy link
Copy Markdown
Contributor

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.0 and purging through bash -s -- --purge both behave as written, and an install-then-uninstall round trip left the shell profile byte-for-byte as it started.

@kanushka
kanushka requested a review from hevayo as a code owner August 10, 2026 18:34
@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 846af536-af9f-4fe5-bd90-3e5c056931a6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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=1 here only applies to curl, not to bash executing 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/wso2 is only set for curl, not for bash running the installer, so the install location won’t actually change. The env var needs to be set on the bash side (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.

Comment thread docs/guides/installing.md Outdated
Comment thread docs/guides/installing.md Outdated
@kanushka
kanushka merged commit a10f335 into feat/release-artifacts-issue-53 Aug 11, 2026
6 checks passed
@kanushka
kanushka deleted the feat/install-docs-issue-57 branch August 19, 2026 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants