Skip to content
This repository has been archived by the owner on Mar 11, 2024. It is now read-only.

Commit

Permalink
Update the README.md file for v3.
Browse files Browse the repository at this point in the history
  • Loading branch information
junyer committed Feb 2, 2024
1 parent c4e60e2 commit b39c379
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# setup-bazelisk v2
# setup-bazelisk v3
Set up your GitHub Actions workflow with a specific version of Bazelisk

Note that GitHub Actions includes Bazelisk by default as of <https://github.com/actions/virtual-environments/pull/490> so this setup is not necessary unless you want to customize the Bazelisk version, or are running Bazel inside a container.
Expand All @@ -12,8 +12,8 @@ This action sets up Bazelisk for use in actions by:

# What's new

- Updated to the node16 runtime by default
- This requires a minimum [Actions Runner](https://github.com/actions/runner/releases/tag/v2.285.0) version of v2.285.0 to run, which is by default available in GHES 3.4 or later.
- Updated to the node20 runtime by default
- This requires a minimum [Actions Runner](https://github.com/actions/runner/releases/tag/v2.308.0) version of v2.308.0 to run.

# Usage

Expand All @@ -22,10 +22,10 @@ See [action.yml](action.yml)
Basic:
```yaml
steps:
- uses: actions/checkout@v3
- uses: bazelbuild/setup-bazelisk@v2
- uses: actions/checkout@v4
- uses: bazelbuild/setup-bazelisk@v3
- name: Mount bazel cache # Optional
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: "~/.cache/bazel"
key: bazel
Expand All @@ -34,7 +34,7 @@ steps:
# Known issues on Windows
* This action doesn't work with PowerShell. Make sure to have `shell: bash` in you `run:` steps. ([#3](https://github.com/bazelbuild/setup-bazelisk/issues/3))
* Windows removes one of the slashes (`/`) when two are present (`bazel test //tests/...` becomes `bazel test /tests/...` and fails). ([#4](https://github.com/bazelbuild/setup-bazelisk/issues/4))
* Windows removes one of the slashes (`/`) when two are present (`bazel test //tests/...` becomes `bazel test /tests/...` and fails). ([#4](https://github.com/bazelbuild/setup-bazelisk/issues/4))
As a workaround, don't have any prefix `//`. Since all runs start at WORKSPACE dir, it should work all the same.

Full workaround example on windows:
Expand Down

0 comments on commit b39c379

Please sign in to comment.