Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Scripts and documentation still refer to pre-Go-module practices #2763

Open
mhutchinson opened this issue Jun 21, 2022 · 1 comment
Open

Scripts and documentation still refer to pre-Go-module practices #2763

mhutchinson opened this issue Jun 21, 2022 · 1 comment
Labels
cleanup

Comments

@mhutchinson
Copy link
Contributor

Almost anything that references GOPATH/src is from prior to go modules being fully adopted. It used to be that having all go code in that directory was expected (required?). Now it is only there if users go out of their way to check out code there.

I'm working on cleaning up the easy references to this, but there will be a long tail that might take some time to tidy up as they are deep in scripts that haven't been run in some time (e.g. scripts for running on public GCP).
mhutchinson added a commit to mhutchinson/trillian that referenced this issue Jun 21, 2022
@mhutchinson
Updated README to better document required tools
b530e84 
Having just set this up again on a new machine, the old instructions were lacking. Also referenced google#2763 on the dubious installation of googleapis into go src.
@mhutchinson mhutchinson mentioned this issue Jun 21, 2022
Merged
mhutchinson added a commit that referenced this issue Jun 21, 2022
@mhutchinson
Updated README to better document required tools (#2764)
44e4aff 
Having just set this up again on a new machine, the old instructions were lacking. Also referenced #2763 on the dubious installation of googleapis into go src.
mhutchinson added a commit to mhutchinson/trillian that referenced this issue Jun 21, 2022
@mhutchinson
Manually vendor the required .proto files from googleapis
717047e 
This resolves some weird references to GOPATH, that while it worked, was weird (google#2763). It also simplifies new user onboarding (one less instruction to follow), makes CI more lightweight (one less big repo to clone), and avoids mismatched versions of these protos from causing havoc (because they were less hermetic before).
@mhutchinson mhutchinson mentioned this issue Jun 21, 2022
Merged
mhutchinson added a commit that referenced this issue Jun 22, 2022
@mhutchinson
Manually vendor the required .proto files from googleapis (#2765)
3d6672f 
This resolves some weird references to GOPATH, that while it worked, was weird (#2763). It also simplifies new user onboarding (one less instruction to follow), makes CI more lightweight (one less big repo to clone), and avoids mismatched versions of these protos from causing havoc (because they were less hermetic before).
mhutchinson added a commit to mhutchinson/trillian that referenced this issue Jun 24, 2022
@mhutchinson
Remove broken installation instructions and run binary directly
24c26d5 
The  command given didn't work. We could change this to specify the install with  as a suffic, but skipping installation and path setup seems even easier and more direct.

This fixes another case of google#2763.
@mhutchinson mhutchinson mentioned this issue Jun 24, 2022
Merged
mhutchinson added a commit that referenced this issue Jun 24, 2022
@mhutchinson
Change broken installation instructions to just run the binary direct…
aa39f5a 
…ly (#2766)

The  command given didn't work. We could change this to specify the install with  as a suffic, but skipping installation and path setup seems even easier and more direct.

This fixes another case of #2763.
@mhutchinson
Copy link
Contributor Author

The remaining work here is in the example/deployment directories. git grep src/github.com/google/trillian seems a pretty good way to catch these:

examples/deployment/aws/terraform.tf:cd /go/src/github.com/google/trillian
examples/deployment/docker/db_client/Dockerfile:ADD . /go/src/github.com/google/trillian
examples/deployment/docker/db_client/Dockerfile:WORKDIR /go/src/github.com/google/trillian
examples/deployment/docker/db_server/Dockerfile:# expects the build context to be: $GOPATH/src/github.com/google/trillian
examples/deployment/kubernetes/deploy.sh:cd $GOPATH/src/github.com/google/trillian
examples/deployment/kubernetes/mysql/README.md:kubectl apply -f $GOPATH/src/github.com/google/trillian/storage/mysql/kubernetes
examples/deployment/kubernetes/mysql/README.md:$GOPATH/src/github.com/google/trillian/storage/mysql/kubernetes/resetdb.sh
examples/deployment/kubernetes/undeploy.sh:cd $GOPATH/src/github.com/google/trillian

Any changes to these files should be done with a working public environment to deploy them to, in order to confirm the new steps succeed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cleanup
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mhutchinson