Skip to content

chore: update README to include instructions on bazelisk installation#1271

Merged
burkedavison merged 4 commits intomainfrom
update-readme
Jan 26, 2023
Merged

chore: update README to include instructions on bazelisk installation#1271
burkedavison merged 4 commits intomainfrom
update-readme

Conversation

@mpeddada1
Copy link
Copy Markdown
Contributor

No description provided.

@mpeddada1 mpeddada1 requested review from a team and burkedavison January 24, 2023 21:00
Comment thread DEVELOPMENT.md Outdated
Before running the integration tests, make sure to install bazelisk:

```shell
$ go install github.com/bazelbuild/bazelisk@latest
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hm. I'm surprised you needed to explicitly install bazelisk -- I think it came with my bazel installation, or I'm forgetting the manual install...

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

oh interesting! For me, it was still missing despite install bazel:

mpeddada@mpeddada:~/IdeaProjects/gapic-generator-java/showcase$ sudo apt-get install bazel
[sudo] password for mpeddada: 
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
bazel is already the newest version (6.0.0).
0 upgraded, 0 newly installed, 0 to remove and 0 not upgraded.
mpeddada@mpeddada:~/IdeaProjects/gapic-generator-java/showcase$ bazelisk
bash: bazelisk: command not found

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ah. Yes. You are correct.

$ which bazelisk
/opt/homebrew/bin/bazelisk
$ brew list
==> Formulae
bazelisk [...]

So at some point I invoked brew install bazelisk

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think you do have to install bazelisk separately, I learned that the hard way.
Another nit, this would require us to install go as well, I know go is already required for showcase testing so this is easy for us to set up the environment, but do we want to add more info(e.g. bazelisk Github page) for what bazelisk is and how to set it up in case the go install does not work.

Copy link
Copy Markdown
Member

@suztomo suztomo Jan 25, 2023

Choose a reason for hiding this comment

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

@mpeddada1 Add a link to bazelisk installation documentation. I don't want readers relying on 'go'. (I use npm to use bazelisk.). Move that paragraph to "## Set Up" section.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done. Replaced the instruction with a link to the Github page and moved it to "Set Up". Thank you!

@sonarqubecloud
Copy link
Copy Markdown

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@burkedavison burkedavison merged commit d4efc37 into main Jan 26, 2023
@burkedavison burkedavison deleted the update-readme branch January 26, 2023 16:28
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.

4 participants