Skip to content

readme: add section on versioning #772

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

Merged
merged 4 commits into from
Jan 30, 2018
Merged

Conversation

willnorris
Copy link
Collaborator

This does not yet address some of the additional workflows and policies we'll need to adopt as a result. For example, when do we cut new releases, do we attempt to maintain a formal changelog, or at least release notes when we cut a new release, etc. This also requires that we update go docs to call out which methods are exposing preview functionality from the GitHub API.

Fixes #376

@googlebot googlebot added the cla: yes Indication that the PR author has signed a Google Contributor License Agreement. label Nov 1, 2017
@gmlewis
Copy link
Collaborator

gmlewis commented Nov 1, 2017

This sounds good to me.

One thing I'm left wondering is... what does libraryVersion now become?
Do we want to add a section in CONTRIBUTING.md that describes how contributors are expected to bump the libraryVersion on each PR? Or do we only use GitHub tagged releases for this new versioning? (Or both? ...probably not.)

This may all fall under "additional workflows and policies" that you called out in the description above, so maybe it can all be addressed later.

@dmitshur
Copy link
Member

dmitshur commented Nov 2, 2017

Nit: The rest of README.md, and Go style at large uses 1 space between sentences, not two.

Everything I read sounds reasonable and SGTM, up until this part:

We do our best to call out which portions of a method's behavior and/or data are part of a GitHub Preview in the appropriate Go doc.

I don't think we should do that, we should have people look that information up in GitHub documentation. I think it would cause too much churn to deal with in our Go package, and it'd end up being too inaccurate and out of date more often than not. It'd cause merge conflicts, delays in PRs being merged, etc. In the end, I see not nearly enough benefit, but huge downsides.

Also, as Glenn mention, we need to figure out how libraryVersion would intersect with this. Would we change libraryVersion to be semver? Get rid of it completely? Something else?

@willnorris willnorris mentioned this pull request Dec 20, 2017
Copy link
Collaborator

@gmlewis gmlewis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you, @willnorris!

README.md Outdated
@@ -238,6 +238,29 @@ straightforward.
[roadmap]: https://docs.google.com/spreadsheet/ccc?key=0ApoVX4GOiXr-dGNKN1pObFh6ek1DR2FKUjBNZ1FmaEE&usp=sharing
[contributing]: CONTRIBUTING.md

## Versioning ##

In general, go-github follows [semver](http://semver.org/) as closely as we can
Copy link
Member

@dmitshur dmitshur Jan 30, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/http/https/

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed.

@willnorris
Copy link
Collaborator Author

I've created historical tags for v2.0.0 through v15.0.0, corresponding to each time the libraryVersion was bumped. Going forward, we'll need to decide on a release schedule and tag the release using a version number that reflects whatever changes are included in that release.

@willnorris willnorris merged commit 897969c into google:master Jan 30, 2018
@willnorris willnorris deleted the semver branch May 26, 2021 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Indication that the PR author has signed a Google Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants