Add the documentation for the release model #6297
Merged
Conversation
This file contains hidden or 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
docs/docs/usage/version-numbers.md
Outdated
| @@ -1,17 +0,0 @@ | |||
| --- | |||
There was a problem hiding this comment.
We have several links to this page on the dotty website (e.g. release blog posts).
There was a problem hiding this comment.
Can we make a redirect from that url to the new one?
biboudis
approved these changes
Apr 16, 2019
docs/docs/contributing/release.md
Outdated
| # Model | ||
| The easiest way to produce a release of a GitHub-based open-source software is to tag the most recent commit on the `master` with the version number at regular intervals of time or once a previously agreed milestone is reached. However, this approach to releasing would rest on the assumption that each commit at the `master` branch can potentially be made into a release. We cannot provide the release-grade quality guarantees for each of the `master` commits, though. | ||
|
|
||
| This is why, in Dotty, we are using the above method of naive releasing-by-tagging to mark release candidates (RC’s) and not the stable releases. The stable releases are also marked by a tag, but we have a procedure to assure their quality. |
There was a problem hiding this comment.
revised grammatically
Consequently, in Dotty, we are using the method above--releasing-by-tagging--to mark release candidates (RC’s) and not the stable releases.
docs/docs/contributing/release.md
Outdated
|
|
||
| An RC is promoted to a stable release in one release cycle after its creation. The idea is that this way, we have one release cycle's time to examine the release candidate and find critical issues which cannot be allowed into a stable release. | ||
|
|
||
| If such issues are found, their fixes end up on a separate branch dedicated to that release. In one release cycle after the RC creation, the RC, along with all its afterthought fixes, is promoted to a stable release by means of tagging it. |
There was a problem hiding this comment.
afterthought -> subsequent (cannot be used as adjective)
docs/docs/contributing/release.md
Outdated
| If such issues are found, their fixes end up on a separate branch dedicated to that release. In one release cycle after the RC creation, the RC, along with all its afterthought fixes, is promoted to a stable release by means of tagging it. | ||
|
|
||
| # Example | ||
| Say we want to release the 0.14.0 version. The process to do so (at a glance). |
There was a problem hiding this comment.
is the following: or Next we describe the process...
docs/docs/contributing/release.md
Outdated
|
|
||
| ## At the Dotty Repo | ||
| 1. Tag the latest `master` commit as `0.14.0-RC1`. This commit is the release candidate for the `0.14.0` version. | ||
| 2. Create a branch from that commit called `0.14.x`. This branch is intended to host the afterthought fixes to the RC for the issues that cannot be allowed in the `0.14.0` stable release. |
There was a problem hiding this comment.
afterthought -> subsequent
anatoliykmetyuk
force-pushed
the
release-procedure-doc
branch
from
fdb7044 to
9f9ad51
Compare
|
Thanks for the review @biboudis, I've addressed your points. |
anatoliykmetyuk
force-pushed
the
release-procedure-doc
branch
from
9f9ad51 to
d9c87ed
Compare
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.