Debian Codegraph @

subprojects/meson-docs/docs/markdown/Release-procedure.md

raw
1 # Release procedure
2
3 **This page is WIP. The following procedure is not yet approved for use**
4
5 # Trunk
6
7 Meson operates under the principle that trunk should (in theory) be
8 always good enough for release. That is, all code merged in trunk must
9 pass all unit tests. Any broken code should either be fixed or
10 reverted immediately.
11
12 People who are willing to tolerate the occasional glitch should be
13 able to use Meson trunk for their day to day development if they so
14 choose.
15
16 # Major releases
17
18 Major releases are currently in the form 0.X.0, where X is an
19 increasing number. We aim to do a major release roughly once every 3 to 4
20 months, though the schedule is not set in stone.
21
22 Before a major release is made a stable branch will be made, and
23 0.X.0-rc1 release candidate will be made. A new milestone for 0.X.0
24 will be made, and all bugs effecting the RC will be assigned to this
25 milestone. Patches fixing bugs in the milestone will be picked to the
26 stable branch, and normal development will continue on the master
27 branch. Every week after this a new release candidate will be
28 made until all bugs are resolved in that milestone. When all of the
29 bugs are fixed the 0.X.0 release will be made.
30
31 # Bugfix releases
32
33 Bugfix releases contain only minor fixes to major releases and are
34 designated by incrementing the last digit of the version number. The
35 criteria for a bug fix release is one of the following:
36
37 - release has a major regression compared to the previous release (making
38 existing projects unbuildable)
39 - the release has a serious bug causing data loss or equivalent
40 - other unforeseen major issue
41
42 In these cases a bug fix release can be made. It shall contain _only_
43 the fix for the issue (or issues) in question and other minor bug
44 fixes. Only changes that have already landed in trunk will be
45 considered for inclusion. No new functionality shall be added.
46
47 # Requesting a bug fix release
48
49 The process for requesting that a bug fix release be made goes roughly
50 as follows:
51
52 - file a bug about the core issue
53 - file a patch fixing it if possible
54 - contact the development team and request a bug fix release (IRC is the
55 preferred contact medium)
56
57 The request should contain the following information:
58
59 - the issue in question
60 - whether it has already caused problems for real projects
61 - an estimate of how many people and projects will be affected
62
63 There is no need to write a long and complicated request report.
64 Something like the following is sufficient:
65
66 > The latest release has a regression where trying to do Foo using Bar
67 breaks. This breaks all projects that use both, which includes at
68 least [list of affected projects]. This causes problems for X amount
69 of people and because of this we should do a bugfix release.