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

cmd/go: test whether mkalldocs.sh generates a git diff #26735

Closed
kevinburke opened this issue Aug 1, 2018 · 2 comments

Comments

Projects
None yet
3 participants
@kevinburke
Copy link
Contributor

commented Aug 1, 2018

A common error is to check in a documentation change but fail to run mkalldocs.sh to compile this change into the public Go binary documentation.

It would be good if Gobot could run mkalldocs.sh and check whether the command generates a Git diff, i.e. whether all changes have been correctly checked in.

I have a shorthand tool for checking this - github.com/kevinburke/differ - that you invoke by running "differ ./mkalldocs.sh" - if you're interested.

@ianlancetaylor

This comment has been minimized.

Copy link
Contributor

commented Aug 1, 2018

We don't need to do that in gobot, really. We could write a test in cmd/go that does it. Or we could just have cmd/dist build the file.

@ianlancetaylor ianlancetaylor added this to the Unplanned milestone Aug 1, 2018

@gopherbot

This comment has been minimized.

Copy link

commented Aug 4, 2018

Change https://golang.org/cl/127920 mentions this issue: cmd/go: test whether alldocs.go is up to date

@kevinburke kevinburke self-assigned this Aug 4, 2018

@gopherbot gopherbot closed this in d169a42 Aug 20, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.