Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gregmagolan committed Sep 28, 2024
1 parent 9d5c52d commit 18012aa
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 10 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/install_snippet.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,17 @@ See full install instructions in [README.md](https://github.com/aspect-build/asp
### Bazelisk (MacOS / Linux)
Configure [bazelisk](https://github.com/bazelbuild/bazelisk) to use the Aspect CLI OSS for all developers. Add this to \`.bazeliskrc\` in your project folder:
Configure [bazelisk](https://github.com/bazelbuild/bazelisk) to use the Aspect CLI OSS for all developers in a repository
by adding the following to \`.bazeliskrc\` in the repository root:
\`\`\`
BAZELISK_BASE_URL=https://github.com/aspect-build/aspect-cli/releases/download
USE_BAZEL_VERSION=aspect/${TAG}
\`\`\`
> [!NOTE]
> This approach doesn't provide the \`aspect init\` command, which has to run outside a Bazel workspace.
The underlying version of Bazel can be configured in your \`.bazelversion\` file or the \`BAZEL_VERSION\` environment variable.
EOF
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,15 @@ We intend for Aspect CLI to remain free for individuals (only for personal use),

### Bazelisk (MacOS / Linux)

Aspect CLI OSS can also be installed in an existing Bazel workspace using [bazelisk].
Aspect CLI OSS can be installed in an existing Bazel workspace using [bazelisk].

> [!NOTE]
> This approach doesn't provide the `aspect init` command, which has to run outside a Bazel workspace.
From the [OSS releases page](https://github.com/aspect-build/aspect-cli/releases),
copy the `.bazeliskrc` snippet into your `.bazeliskrc` file to install Aspect for all developers in the target repository.

Note that in all cases, the `.bazelversion` file continues to indicate which version of the
Bazel tool is fetched and run beneath the wrapper.
The underlying version of Bazel can be configured in your `.bazelversion` file or the `BAZEL_VERSION` environment variable.

### Manual (MacOS / Linux)

Expand All @@ -65,17 +67,26 @@ This installs the `aspect` command and also links it to `bazel`, just like the [

### Bazelisk (MacOS / Linux)

In an already-existing Bazel workspace, you can have [bazelisk]
install the Aspect CLI just like it can install the Bazel CLI.
Aspect CLI can be installed in an existing Bazel workspace using [bazelisk].

> [!NOTE]
> This approach doesn't provide the `aspect init` command, which has to run outside a Bazel workspace.
From the [releases page](https://docs.aspect.build/cli/releases),
copy the `.bazeliskrc` snippet into your `.bazeliskrc` file to install Aspect for all developers in this repository.
Configure [bazelisk](https://github.com/bazelbuild/bazelisk) to use the Aspect CLI for all developers in a repository
by adding the following to \`.bazeliskrc\` in the repository root:

\`\`\`
BAZELISK_BASE_URL=https://static.aspect.build/aspect
USE_BAZEL_VERSION=aspect/xxxx.xx.xx
\`\`\`

Check the Aspect CLI [Homebrew formula](https://github.com/aspect-build/homebrew-aspect/blob/main/Formula/aspect.rb) for
latest version of Aspect CLI.

> [!NOTE]
> An Aspect CLI releases page with release notes and past releases is coming soon.
Note that in all cases, the `.bazelversion` file continues to indicate which version of the
Bazel tool is fetched and run beneath the wrapper.
The underlying version of Bazel can be configured in your `.bazelversion` file or the `BAZEL_VERSION` environment variable.

## Windows

Expand Down

0 comments on commit 18012aa

Please sign in to comment.