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

cmd/go: add mod tidy -check #27005

Open
fishy opened this Issue Aug 15, 2018 · 5 comments

Comments

Projects
None yet
7 participants
@fishy

fishy commented Aug 15, 2018

Please answer these questions before submitting your issue. Thanks!

What version of Go are you using (go version)?

go version go1.11rc1 darwin/amd64

Does this issue reproduce with the latest release?

N/A

What operating system and processor architecture are you using (go env)?

GOARCH="amd64"
GOOS="darwin"

What did you do?

  • Remove lines from go.mod and go.sum files
  • Run go mod tidy to add them back

What did you expect to see?

go mod tidy should return non-zero as it made changes. This way it could be integrated to tools like pre-commit hooks to make sure that we don't commit untidied go.mod and go.sum files into version control

What did you see instead?

go mod tidy returned zero

@mvdan

This comment has been minimized.

Member

mvdan commented Aug 15, 2018

Non-zero exit codes are usually for errors, so having it behave like this by default would be counter-intuitive.

Perhaps it could have something similar to gofmt, which has the -l and -d flags to tell if any changes were made.

@swtch1

This comment has been minimized.

swtch1 commented Aug 15, 2018

If the files are successfully added why wouldn't you want to see a 0 status code? This means that the following script would fail:

#!/usr/bin/env bash
set -e
go mod tidy  # <-- non 0 return code
echo 'we never get here'
@fishy

This comment has been minimized.

fishy commented Aug 15, 2018

That makes sense. How about maybe make it optional? e.g. when it's executed with a flag it should return non-zero when it made any changes.

@thepudds

This comment has been minimized.

thepudds commented Aug 15, 2018

@gopherbot, please add label modules

@gopherbot gopherbot added the modules label Aug 15, 2018

@rsc rsc changed the title from modules: `go mod tidy` should return non-zero when it made changes to go.mod and/or go.sum files to cmd/go: add mod tidy -check Aug 18, 2018

@rsc

This comment has been minimized.

Contributor

rsc commented Aug 18, 2018

We could think about adding a flag that means "don't do the update, but fail if one is needed".
Not sure exactly what to call it but I put -check in the description. Needs more thought.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment