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

Tag a release / add Glide dependency manifest for related projects. #65

Closed
smyrman opened this issue Dec 15, 2016 · 4 comments
Closed

Comments

@smyrman
Copy link
Collaborator

smyrman commented Dec 15, 2016

An example of a change that could introduce a version mismatch between rest-layer and supporting libraries for end-user, is #62.

Minimum solution

To allow end-users to better cope with minor breaking changes before a rest-layer v1.0, and to improve the ability end-users have for reproducibility, I propose to as a minimum tag a release v0.1.0 following semver conventions.

How to handle breaking changes

According to the semver spec: item 4, versions 0.y.z are for initial development, and anything may break at any time. However, I suggest that for a breaking change pre v1.0.0, MINOR (y) needs to be incremented. I.e. there should be no breaking changes in a PATCH (z) release.

For additional stability only

To futher allow people to minimize the risk of unpredictable behaviour due to version mismatch, I suggest that supporting repositories such as rest-layer-mongo etc., gets a manifest file describing which rest-layer version they require. I suggest this version number to be locked to MAJOR and MINOR pre v1.0.0. E.g. with Glide syntax:

import:
- package: github.com/rs/rest-layer
  version: ~0.1

Until an official Go manifest format is defined, I suggest relying on a Glide manifest.

EDIT: Corrected some mistakes, including referring to a lock of MAJOR and PATCH.
EDIT 2: Added headings.

@smyrman
Copy link
Collaborator Author

smyrman commented Dec 15, 2016

Link to Glide home page btw: http://glide.sh/

@smyrman
Copy link
Collaborator Author

smyrman commented Jan 3, 2017

As briefly discussed in #77, we won't add a Glide manifest at this point, but instead wait for the Go team to release an official manifest format.

A Git tag should still be performed. Semver suggests starting at v0.1.0 and increase incrementally from there.

@rs
Copy link
Owner

rs commented Jan 4, 2017

v0.1.0 tagged.

@smyrman
Copy link
Collaborator Author

smyrman commented Jan 4, 2017

Let's close this for now.

@smyrman smyrman closed this as completed Jan 4, 2017
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

No branches or pull requests

2 participants