Add versioning notes to release.md #629
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
maffoo
reviewed
Jul 11, 2018
release.md
Outdated
| to the release. In the pull request corresponding to the release | ||
| the [version file](cirq/_version.py) should be updated. After | ||
| that version is cut, a future pull request should update the | ||
| version to the next minor version with `-dev` appended. |
There was a problem hiding this comment.
Might want to do vX.X.X.dev instead to match what python tooling expects for package versions (see https://www.python.org/dev/peps/pep-0440/#public-version-identifiers). Or could leave the branch names with -dev but should also document what the package versions do.
|
Update as suggested to use ".dev" Also changed _version.py |
Strilanc
reviewed
Jul 11, 2018
| releases. Versions are labeled MAJOR.MINOR.PATCH where each of these | ||
| is a numerical value. The rules for versions changes are: | ||
| * Before MAJOR becomes 1, updates to MINOR can and will make changes to | ||
| public facing apis and interfaces.. |
| [on the Cirq release page](https://github.com/quantumlib/Cirq/releases). | ||
|
|
||
| Our development process uses the `master` branch for development. | ||
| When a release is made for a major or minor version update, `master` |
There was a problem hiding this comment.
I would say that a commit is tagged, not master.
There was a problem hiding this comment.
changed to "a commit to the master branch"
|
|
||
| Our development process uses the `master` branch for development. | ||
| When a release is made for a major or minor version update, `master` | ||
| is tagged with a version tag (vX.X.X) for a pull request corresponding |
There was a problem hiding this comment.
What do you mean by a pull request corresponding to the release? Like, we make a pull request "Release vX", merge it, and the resulting commit is what we tag?
| version to the next minor version with `.dev` appended. | ||
|
|
||
| For patch version updates (bug fixes), we follow a different pattern. | ||
| For these we create a separate branch that off of the version the |
| For patch version updates (bug fixes), we follow a different pattern. | ||
| For these we create a separate branch that off of the version the | ||
| major minor version for the patch, or a previous branch patch. The | ||
| branches should be of the name `branch-X-X-X` corresponding to the |
Strilanc
added
the
automerge
Strilanc
removed
the
automerge
Strilanc
added
the
automerge
Strilanc
removed
the
automerge
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.
No description provided.