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

x/website/blog: write a post on go.mod and go.sum misconceptions #48539

Open
mvdan opened this issue Sep 22, 2021 · 3 comments
Open

x/website/blog: write a post on go.mod and go.sum misconceptions #48539

mvdan opened this issue Sep 22, 2021 · 3 comments
Labels
NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@mvdan
Copy link
Member

mvdan commented Sep 22, 2021

This issue aims to track https://groups.google.com/g/golang-dev/c/wkIlHZL-NNk/m/xy2fFHs6BwAJ. We all seemed to agree that this blog post would be a good idea, but tracking who will do that and when it will happen is hard if all we have is an old email thread that's easy to forget.

I am more than happy to volunteer my help in this, or to even write the first draft. I don't think I've authored anything on the Go blog before. That said, I'm not a technical writer, and there are others who know the details of how go.mod and go.sum work better than I do. So I'm also happy to stand aside or simply provide reviews.

cc @jayconrod @stevetraut

@gopherbot gopherbot added this to the Unreleased milestone Sep 22, 2021
@mvdan
Copy link
Member Author

mvdan commented Sep 22, 2021

In that email thread, Jay mentions whether this should be a maintained doc page as opposed to a mostly-frozen blog post. I replied to that point by mentioning that a blog post gets much wider attention as "new content" that can be digested in fifteen minutes. As opposed to a section within a large body of documentation that would likely take a full day's worth of attention to slowly go through.

@mknyszek mknyszek added the NeedsFix The path to resolution is known, but the work has not been done. label Oct 4, 2021
@mvdan
Copy link
Member Author

mvdan commented Mar 15, 2022

Just to reiterate, I'm happy to write a draft for this post, or co-author it with someone else. I won't start unless I get the green light though, because ultimately I cannot upload content to the blog myself.

@ArnaudBrousseau
Copy link

@mvdan thanks for opening this issue, I'm glad I found it. As someone who, until recently, bought into the "go.sum is a lock file" myth, I'd be happy to see an official blog post dispelling it. The section of the Go docs explaining why multiple versions of the same package can be present in go.sum (even if a single version is used) is deeply buried under the MVS section. The "aha!" moment for me came from reading the following:

The build list may be inspected with the command go list -m all. Unlike other dependency management systems, the build list is not saved in a “lock” file. MVS is deterministic, and the build list doesn’t change when new versions of dependencies are released, so MVS is used to compute it at the beginning of every module-aware command

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

4 participants