pci-gke-blueprint icon indicating copy to clipboard operation
pci-gke-blueprint copied to clipboard

Published 20 hours ago • verified publisher icon GoogleCloudPlatform

Update Prereqs section to include shellcheck

Open josebiro opened this issue 4 years ago • 5 comments

This adds the shellcheck tool to prereqs and link to install instructions.

josebiro avatar Sep 11 '20 17:09 josebiro

I believe this is only required for contributing to the blueprint (running make commands), could we put it in CONTRIBUTING.md.

I don't mind, but there is no existing section for development prereqs in the CONTRIBUTING.md file today and I'm not aware of all of the development requirements. Happy to create a new Development Prereqs section if there's a bit more material to start with.

josebiro avatar Sep 14 '20 16:09 josebiro

You could list:

  • Make
  • Go
  • Terraform
  • Shellcheck

Also it should probably go in the development doc: https://github.com/GoogleCloudPlatform/pci-gke-blueprint/blob/master/docs/development.md

morgante avatar Sep 14 '20 16:09 morgante

Perhaps if development.md wasn't easily found we should link to it in contributing.md too?

jmound avatar Sep 14 '20 16:09 jmound

Perhaps if development.md wasn't easily found we should link to it in contributing.md too?

Indeed - that's a good idea.

morgante avatar Sep 14 '20 16:09 morgante

I addressed this in #122. @josebiro @morgante Let me know if this is/is not good to close, or if more changes are needed.

Separately, I opened #123 to resolve the cloud build errors.

jmound avatar Oct 01 '20 14:10 jmound