Add readme note about go module versioning #2589
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DrJosh9000
approved these changes
Jan 17, 2024
| @@ -126,6 +126,10 @@ our Go dependencies. Dependencies are not | |||
| [vendored](https://go.dev/ref/mod#go-mod-vendor) into the repository unless | |||
| necessary. | |||
|
|
|||
| The go module published by this repo (ie the one you could use by adding `import "github.com/buildkite/agent/v3"` to your code) | |||
There was a problem hiding this comment.
Suggested change
| The go module published by this repo (ie the one you could use by adding `import "github.com/buildkite/agent/v3"` to your code) | |
| The Go module published by this repo (i.e. the one you could use by adding `import "github.com/buildkite/agent/v3"` to your code) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
we change public method signatures all the time, and we should call it out to users in the readme. i more or less crammed this in the first place in the readme i thought would fit it, but i'm happy for it to go elsewhere