Skip to content

Delete instruction to use GOPATH from the CONTRIBUTING's setup tutorial#1369

Merged
carolynvs merged 2 commits intogetporter:mainfrom
joshuabezaleel:delete-gopath-contributing-setup
Nov 18, 2020
Merged

Delete instruction to use GOPATH from the CONTRIBUTING's setup tutorial#1369
carolynvs merged 2 commits intogetporter:mainfrom
joshuabezaleel:delete-gopath-contributing-setup

Conversation

@joshuabezaleel
Copy link
Copy Markdown
Contributor

What does this change

It deletes the line on the initial setup from 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 install from a directory outside of the GOPATH and it produces the porter binary. Screenshot is attached below.
image

What issue does it fix

Closes #1286

Notes for the reviewer

Checklist

  • Unit Tests
  • Documentation
  • Schema (porter.yaml)

Copy link
Copy Markdown
Member

@carolynvs carolynvs left a comment

Choose a reason for hiding this comment

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

Thanks for checking that these instructions work on a fresh machine outside of GOPATH!

Comment thread CONTRIBUTING.md
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.
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.

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.

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.

Ah that was handy! Will keep that in mind for future changes 🙂

@carolynvs
Copy link
Copy Markdown
Member

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 git push --force and you should quickly see the "DCO" check pass

Signed-off-by: Joshua Bezaleel Abednego <joshua.bezaleel@gmail.com>
Signed-off-by: Joshua Bezaleel Abednego <joshua.bezaleel@gmail.com>
@joshuabezaleel joshuabezaleel force-pushed the delete-gopath-contributing-setup branch from 75c44f5 to ba20c1d Compare November 18, 2020 09:13
@joshuabezaleel
Copy link
Copy Markdown
Contributor Author

@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! 🙂
Ah sorry that I skipped that part. The check should be good by now 😄

@carolynvs
Copy link
Copy Markdown
Member

I'll update the tutorial to have people install the git commit hook. Thanks for running through it and finding gaps!

@carolynvs carolynvs self-assigned this Nov 18, 2020
@carolynvs carolynvs merged commit 7e120aa into getporter:main Nov 18, 2020
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.

Fix setup instructions to not need GOPATH

2 participants