Skip to content

Add go.mod and go.sum files to support Go modules. #67

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

Closed
wants to merge 1 commit into from
Closed

Add go.mod and go.sum files to support Go modules. #67

wants to merge 1 commit into from

Conversation

creachadair
Copy link

In order to work well with Go modules a package should have go.mod and go.sum files and semantic version tags on release versions. This commit adds those files. No functional changes are intended.

Assuming you accept this change, I recommend that you also run git tag v0.0.1 master ; git push origin v0.0.1 after it is merged, to start the release history. If the API of the package is considered stable, you could instead use v1.0.0, but at that point module users will expect breaking changes to increment the major version. I don't have a clear sense of how much this package is maintained, so v0 would be a safe default for now.

In order to work well with [Go modules][1] a package should have go.mod and
go.sum files and semantic version tags on release versions. This commit adds
those files. No functional changes are intended.

[1]: https://github.com/golang/go/wiki/Modules
@creachadair
Copy link
Author

Given this comment in the README:

NOTE: This library is in active development. As such, there are no guarantees about the stability of the API. The author reserves the right to arbitrarily break the API for any reason.

I imagine v0.0.1 would be a sensible default.

@dsnet
Copy link
Owner

dsnet commented Feb 20, 2019

Thanks for the PR. Sigh... my Travis script is messed up. It doesn't build and test hermetically

@creachadair
Copy link
Author

Thanks for the PR. Sigh... my Travis script is messed up. It doesn't build and test hermetically

I saw that, but I haven't yet figured out whether that's triggered by this change. I did wind up having to manually install zstd to make it build locally, but it does pass all its tests when I do. I only tested Go 1.11.5 though.

@dsnet
Copy link
Owner

dsnet commented Feb 20, 2019

triggered by this change

It's not. The script calls go get github.com/golang/lint/golint and go get honnef.co/go/tools/cmd/staticcheck without any specification of the exact version. I'm currently OOO until next monday. I can fix my script when I get back. Is this PR blocking something else?

@creachadair
Copy link
Author

It's not. The script calls go get github.com/golang/lint/golint and go get honnef.co/go/tools/cmd/staticcheck without any specification of the exact version.

I ran into this when trying to make a similar change in sergi/go-diff#98. I don't see any really graceful solution to it, apart from maybe vendoring a binary of golint.

I'm currently OOO until next monday. I can fix my script when I get back. Is this PR blocking something else?

It is not urgent, can wait. I'm just trying to clean up the dependencies of http://kythe.io/ so that we can use modules for our Go build.

@dsnet
Copy link
Owner

dsnet commented Mar 6, 2019

Apologies for the delay, but I finally got around to fixing the travis script. See #68. Part of the fix involved added a go.mod file anyways, so this PR is redundant now. Thanks for prodding me to get this fixed.

BTW, a tag has now been issues for v0.0.1.

@dsnet dsnet closed this Mar 6, 2019
@creachadair
Copy link
Author

Great, thanks so much.

@creachadair creachadair deleted the gomod branch March 6, 2019 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants