Adding release process documentation to README.md #4402
Conversation
|
@gvashishtha This PR has been outstanding for a long time. If there are no imminent plans to check this in then I suggest we close this and revisit when it is ready to merged. |
|
@codemzs please take a look at this, make sure it is consistent with our conversation today. |
merging latest questions
README.md
Outdated
| | -------------|-------------|-------------|-------------|-------------| | ||
| | Nightly build| No change | No change | No change | No change | | ||
| | Monthly preview| No change | No change | No change | `preview` tag added, if this is the first preview, or preview index incremented (i.e. `A.B.C-preview` -> `A.B.C-preview2`) | | ||
| | GA releases | Possibly incremented for non-WIP NuGets | Incremented | Reset to 0 | `preview` tag is removed | |
There was a problem hiding this comment.
monthly releases can also be GA releases, like 1.4.0
There was a problem hiding this comment.
OK, so in months when there is a monthly GA release, there is no monthly preview release? Like, when 1.4.0 came out, there was no 1.4-preview?
There was a problem hiding this comment.
The idea of preview releases is for our early adopters to preview new apis and features and give us feedback. So, ideally our GA releases should not include new apis and features and should mostly be bug fixes, doc updates, perf improvements and things like that. When we do that, there is no need for a preview release when we make a GA release.
There was a problem hiding this comment.
@harishsk do let me know if the new version is good to go.
| 1. **Daily builds:** these can be downloaded from [this NuGet feed](https://dev.azure.com/dnceng/public/_packaging?_a=feed&feed=MachineLearning), and are built automatically each time a commit is made to the `master` branch. | ||
| 1. **Preview:** These releases are built from the corresponding `A.B-preview-X` GitHub branch, and are expected to meet a higher quality bar than the daily builds. These can also be downloaded from [this NuGet feed](https://dev.azure.com/dnceng/public/_packaging?_a=feed&feed=MachineLearning), or within Visual Studio, as detailed below. When we introduce new API's in a preview release, we avoid doing a GA release at the same time (unless there are patches required for the last GA release). If there are no new API's, then we go straight to a GA release and skip the preview release. | ||
| 1. **GA:** These releases are built from the corresponding `A.B` GitHub branch. They are rigorously tested, stable, and meant for general use. They are also the default choice when installing ML.NET via the `Install-Package Microsoft.ML` command. | ||
| 1. **Fix:** These releases include patches for bugs in either the preview or GA releases. |
There was a problem hiding this comment.
Please add that the GA releases are published to nuget.org and this should be good to go.
Codecov Report
@@ Coverage Diff @@
## master #4402 +/- ##
==========================================
+ Coverage 75.84% 75.86% +0.02%
==========================================
Files 951 951
Lines 172594 172435 -159
Branches 18632 18617 -15
==========================================
- Hits 130896 130811 -85
+ Misses 36523 36443 -80
- Partials 5175 5181 +6
|
|
@gvashishtha can you please pull master so that the checks pass? |
ghost
locked as resolved and limited conversation to collaborators
This PR better documents the release process for ML.NET
Fixes #nnnnin your description to cause GitHub to automatically close the issue(s) when your PR is merged.