File tree Expand file tree Collapse file tree 1 file changed +11
-3
lines changed Expand file tree Collapse file tree 1 file changed +11
-3
lines changed Original file line number Diff line number Diff line change @@ -49,14 +49,22 @@ func doUpdate(url string) error {
4949- Release tooling with proper code signing
5050- Update/download metrics
5151
52- ## Breaking API Changes
53- - Sept 3, 2015: The ` Options ` struct passed to ` Apply ` was changed to be passed by value instead of passed by pointer.
52+ ## API Compatibility Promises
53+ The master branch of ` go-update ` is * not* guaranteed to have a stable API over time. For any production application, you should vendor
54+ your dependency on ` go-update ` with a tool like git submodules, [ gb] ( http://getgb.io/ ) or [ govendor] ( https://github.com/kardianos/govendor ) .
55+
56+ The ` go-update ` package makes the following promises about API compatibility:
57+ 1 . A list of all API-breaking changes will be documented in this README.
58+ 1 . ` go-update ` will strive for as few API-breaking changes as possible.
59+
60+ ## API Breaking Changes
61+ - Sept 3, 2015: The ` Options ` struct passed to ` Apply ` was changed to be passed by value instead of passed by pointer. Old API at ` 28de026 ` .
62+ - Aug 9, 2015: 2.0 API. Old API at ` 221d034 ` or ` gopkg.in/inconshreveable/go-update.v0 ` .
5463
5564## Older API Versions
5665Did your build just break because the go-update API changed? You have two options:
5766
58671 . Update your import to ` gopkg.in/inconshreveable/go-update.v0 `
59- 1 . Vendor your dependency on it with a tool like [ gb] ( http://getgb.io/ ) or [ govendor] ( https://github.com/kardianos/govendor )
6068
6169## License
6270Apache
You can’t perform that action at this time.
0 commit comments