Skip to content

x/website: add clear warning against checking go.work into VCS #62179

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
Closed
goto1134 opened this issue Aug 21, 2023 · 2 comments
Closed

x/website: add clear warning against checking go.work into VCS #62179

goto1134 opened this issue Aug 21, 2023 · 2 comments
Labels
FrozenDueToAge website
Milestone
Unreleased

Comments

@goto1134
Copy link
Contributor

goto1134 commented Aug 21, 2023 •
edited
Loading

Since the original proposal strongly suggests against checking go.work into VCS:

go.work files should not be checked into version control repos containing modules so that the go.work file in a module does not end up overriding the configuration a user created themselves outside of the module. The go.work documentation should contain clear warnings about this.
https://go.googlesource.com/proposal/+/master/design/45713-workspace.md#rationale-the-file

Please add a clear warning against checking go.work into VCS to the documentation here: https://go.dev/ref/mod#go-work-file

This issue is inspired by the following Reddit discussion: https://www.reddit.com/r/golang/comments/15v8i06/why_gowork_file_should_not_be_committed/
@gopherbot gopherbot added this to the Unreleased milestone Aug 21, 2023
goto1134 added a commit to goto1134/website that referenced this issue Aug 21, 2023
@goto1134
_content/ref/mod.md: add clear warning against checking go.work into VCS

Verified

This commit was signed with the committer’s verified signature.
goto1134 Andrei Efanov
SSH Key Fingerprint: SLhjSo3HxA4mB3hyTpwtk6N1EXZmDqszfJtN6AkL59g
Verified
Learn about vigilant mode
23a7606 
Fixes golang/go#62179
@goto1134 goto1134 mentioned this issue Aug 21, 2023
Closed
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/521515 mentions this issue: _content/ref/mod.md: add clear warning against checking go.work into VCS

@seankhliao
Copy link
Member

Duplicate of #53502

@seankhliao seankhliao marked this as a duplicate of #53502 Aug 21, 2023
@seankhliao seankhliao closed this as not planned Won't fix, can't repro, duplicate, stale Aug 21, 2023
@Emptyless Emptyless mentioned this issue Feb 16, 2024
Closed
@golang golang locked and limited conversation to collaborators Aug 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge website
Projects
None yet
Milestone
Unreleased
Development

Successfully merging a pull request may close this issue.

_content/ref/mod.md: add clear warning against checking go.work into VCS goto1134/website
3 participants
@gopherbot @goto1134 @seankhliao