grpc / grpc.github.io

The grpc.io website. (on GitHub pages)
276 stars 381 forks source link

Use gRPC tags rather than branches in docs #719

Closed carl-mastrangelo closed 6 years ago

carl-mastrangelo commented 6 years ago

Tags are more stable than branches, and don't change with time. Prefer using them for the "release".

Generated with:

Over all, the word "branch" very rarely appears in this repo.

hsaliak commented 6 years ago

Branches point to the latest stable point of a branch and include any patch release work. Tags, especially .0 do not.

By using tags, are we not potentially pointing to 'less stable' points in a release branch, than directly pointing to branches? Or do we now need to update this for patch releases as well?

srini100 commented 6 years ago

Branches do not necessarily point to stable commits at all times but release tags do. We will have to update this for patch releases as well.

hsaliak commented 6 years ago

I thought every commit to a stable branch is usually a patch fix, and has to pass a full suite of tests. Ie: we are stable at all times.

srini100 commented 6 years ago

Sometimes we wait for multiple commits in the branch before doing a patch. Patch may go through RC process and deemed to be more stable than individual commits. It's an extra burden to update the yml file. Java has been doing this for some time.

hsaliak commented 6 years ago

Approved -- should we update the release guide to state that patch versions require a version bump on the website?

carl-mastrangelo commented 6 years ago

@hsaliak yes, I updated it.