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.

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

doc/go1.13: highlight need to set GOPRIVATE when using private repos #33796

Closed
AndersonQ opened this issue Aug 23, 2019 · 11 comments
Closed

doc/go1.13: highlight need to set GOPRIVATE when using private repos #33796

AndersonQ opened this issue Aug 23, 2019 · 11 comments

Comments

@AndersonQ
Copy link
Contributor

@AndersonQ AndersonQ commented Aug 23, 2019

What did you do?

I update to go1.13beta1 and used go mod tidy to download private dependencies and it din't work as I had not set GOPRIVATE.

I know it's documented under Tools > Modules > Environment variables. However besides myself other colleges had similar issues when using go 1.13 and I believe others would face similar problems when updating. Therefore I'd like to suggest to state in the Introduction to Go 1.13 section the need/introduction of GOPRIVATE.

@mvdan

This comment has been minimized.

Copy link
Member

@mvdan mvdan commented Aug 23, 2019

@jayconrod

This comment has been minimized.

Copy link
Contributor

@jayconrod jayconrod commented Aug 23, 2019

I'd prefer not to change this in the release notes. We can't adequately explain GOPRIVATE without more than doubling the length of the introduction. The introduction already links to a documentation page that describes GOPRIVATE, and the description in the release notes themselves is only a little further down, right below ports. So this is already mentioned very prominently.

@mvdan

This comment has been minimized.

Copy link
Member

@mvdan mvdan commented Aug 23, 2019

The first GOPRIVATE mention is a full three pages into the changelog, at least on my laptop at the default zoom level; I do think it should be at least be mentioned/linked as a quick warning near the very top of the changelog.

I do think plenty of Go developers won't notice the importance of GOPRIVATE. In a way, the proxy now being a default is a breaking change, as they'd suddenly be leaking private information (such as import paths and version names of closed source modules) to the proxy.

@bcmills

This comment has been minimized.

Copy link
Member

@bcmills bcmills commented Aug 26, 2019

I agree with @jayconrod. The fact that we're now defaulting to the public checksum database is in the very first paragraph of text, and the need to configure something for private module dependencies follows directly from that.

In particular, the go command documentation linked in the very first paragraph of the release notes mentions GOPRIVATE in its second paragraph.

On the other hand, not everyone has private module dependencies. For example, users that have only “leaf” modules (that is, their own possibly-private module plus open-source dependencies) may not care about GOPRIVATE, because all of their private dependencies are already contained within the main module.

Also note that the paragraph describing GOPRIVATE in the release notes proper is also solidly above-the-fold relative to the Modules anchor.

It's true that the word GOPRIVATE is not above the fold in the release notes overall, but given that it is mentioned prominently in several adjacent locations and that it is only useful to a particular subset of users (those using the public proxy but with private module dependencies), I think it is appropriately positioned as-is.

CC @katiehockman

@bcmills bcmills added this to the Go1.13 milestone Aug 26, 2019
@katiehockman

This comment has been minimized.

Copy link
Member

@katiehockman katiehockman commented Aug 26, 2019

I don't have an issue with adding a sentence in that paragraph of Introduction to Go 1.13, especially if people are running into this problem already. Could say something like "If you are using private modules, see the documentation for configuring your environment."

If that sounds good, I'll make a PR.

@mvdan

This comment has been minimized.

Copy link
Member

@mvdan mvdan commented Aug 26, 2019

Yes, the main reason I asked @AndersonQ to file this bug is because he wasn't the first to miss the important piece of information after skimming the release notes for breaking changes.

@gopherbot

This comment has been minimized.

Copy link

@gopherbot gopherbot commented Aug 26, 2019

Change https://golang.org/cl/191746 mentions this issue: doc/go1.13: add information about using private modules to the introduction

@gopherbot gopherbot closed this in 989409f Aug 26, 2019
@andybons

This comment has been minimized.

Copy link
Member

@andybons andybons commented Aug 26, 2019

@gopherbot please create a cherrypick issue for 1.13

@andybons

This comment has been minimized.

Copy link
Member

@andybons andybons commented Aug 26, 2019

Misspelled cherrypick. Bleh.

@gopherbot please consider this for backport to 1.13, it is a documentation change.

@gopherbot

This comment has been minimized.

Copy link

@gopherbot gopherbot commented Aug 26, 2019

Change https://golang.org/cl/191749 mentions this issue: doc/go1.13: add information about using private modules to the introduction

@gopherbot

This comment has been minimized.

Copy link

@gopherbot gopherbot commented Aug 26, 2019

Backport issue(s) opened: #33846 (for 1.13).

Remember to create the cherry-pick CL(s) as soon as the patch is submitted to master, according to https://golang.org/wiki/MinorReleases.

gopherbot pushed a commit that referenced this issue Aug 26, 2019
…te modules to the introduction

Updates #33796
Fixes #33846

Change-Id: I9f6837be96410e96d004523c48bef95ee1427484
Reviewed-on: https://go-review.googlesource.com/c/go/+/191746
Reviewed-by: Bryan C. Mills <bcmills@google.com>
(cherry picked from commit 989409f)
Reviewed-on: https://go-review.googlesource.com/c/go/+/191749
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
tomocy added a commit to tomocy/go that referenced this issue Sep 1, 2019
…uction

Fixes golang#33796

Change-Id: I9f6837be96410e96d004523c48bef95ee1427484
Reviewed-on: https://go-review.googlesource.com/c/go/+/191746
Reviewed-by: Bryan C. Mills <bcmills@google.com>
t4n6a1ka added a commit to t4n6a1ka/go that referenced this issue Sep 5, 2019
…uction

Fixes golang#33796

Change-Id: I9f6837be96410e96d004523c48bef95ee1427484
Reviewed-on: https://go-review.googlesource.com/c/go/+/191746
Reviewed-by: Bryan C. Mills <bcmills@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants
You can’t perform that action at this time.