Delete instruction to use GOPATH from the CONTRIBUTING's setup tutorial#1369
Conversation
carolynvs
left a comment
There was a problem hiding this comment.
Thanks for checking that these instructions work on a fresh machine outside of GOPATH!
| 1. Clone this repository with `git clone https://github.com/getporter/porter.git ~/go/src/get.porter.sh/porter`. Porter relies on being in the GOPATH. | ||
| 1. Run `make build install` from within the newly cloned repository. | ||
| 1. Clone this repository with `git clone https://github.com/getporter/porter.git ~/go/src/get.porter.sh/porter`. | ||
| 2. Run `make build install` from within the newly cloned repository. |
There was a problem hiding this comment.
You don't need to change this back but I wanted to share why you will see numbered markdown lists with every item at 1.. The markdown processor handles figuring out the number for you which is helpful when inserting new steps in the middle. You don't need to then update all the other numbers to match.
There was a problem hiding this comment.
Ah that was handy! Will keep that in mind for future changes 🙂
|
One more thing and then we can merge your pull request. You need to edit your commit and sign it. Here are the instructions on how to do that: https://github.com/getporter/porter/blob/main/CONTRIBUTING.md#signing-your-commits After you do that, force push your branch back up with |
Signed-off-by: Joshua Bezaleel Abednego <joshua.bezaleel@gmail.com>
Signed-off-by: Joshua Bezaleel Abednego <joshua.bezaleel@gmail.com>
75c44f5 to
ba20c1d
Compare
|
@carolynvs The thank you should be mine to say for writing a local dev env setup tutorial article that is crystal clear and works like charm! 🙂 |
|
I'll update the tutorial to have people install the git commit hook. Thanks for running through it and finding gaps! |
What does this change
It deletes the line on the
initial setupfrom the CONTRIBUTING.md file where it said that porter needs to reside at GOPATH.This does not needed anymore since go module is introduced and enabled.
I tried this on my local machine to run

make build installfrom a directory outside of the GOPATH and it produces the porter binary. Screenshot is attached below.What issue does it fix
Closes #1286
Notes for the reviewer
Checklist