• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# How to determine if an early patch release is warranted
2
3In the curl project we do releases every 8 weeks. Unless we break the cycle
4and do an early patch release.
5
6We do frequent releases partly to always have the next release "not too far
7away".
8
9## Bugfix
10
11During the release cycle, and especially in the beginning of a new cycle (the
12so-called "cool down" period), there are times when a bug is reported and
13after it has been subsequently fixed correctly, the question might be asked:
14is this bug and associated fix important enough for an early patch release?
15
16The question can only be properly asked when a fix has been created and landed
17in the git master branch.
18
19## Early release
20
21An early patch release means that we ship a new, complete and full release
22called `major.minor.patch` where the `patch` part is increased by one since
23the previous release. A curl release is a curl release. There is no small or
24big and we never release just a patch. There is only "release".
25
26## Questions to ask
27
28 - Is there a security advisory rated high or critical?
29 - Is there a data corruption bug?
30 - Did the bug cause an API/ABI breakage?
31 - Will the problem annoy a significant share of the user population?
32
33If the answer is yes to one or more of the above, an early release might be
34warranted.
35
36More questions to ask ourselves when doing the assessment if the answers to
37the three ones above are all 'no'.
38
39 - Does the bug cause curl to prematurely terminate?
40 - How common is the affected buggy option/feature/protocol/platform to get
41   used?
42 - How large is the estimated impacted user base?
43 - Does the bug block something crucial for applications or other adoption of
44   curl "out there" ?
45 - Does the bug cause problems for curl developers or others on "the curl
46   team" ?
47 - Is the bug limited to the curl tool only? That might have a smaller impact
48   than a bug also present in libcurl.
49 - Is there a (decent) workaround?
50 - Is it a regression? Is the bug introduced in this release?
51 - Can the bug be fixed "easily" by applying a patch?
52 - Does the bug break the build? Most users do not build curl themselves.
53 - How long is it until the already scheduled next release?
54 - Can affected users safely rather revert to a former release until the next
55   scheduled release?
56 - Is it a performance regression with no functionality side-effects? If so it
57   has to be substantial.
58
59## If an early release is deemed necessary
60
61Unless done for security or similarly important reasons, an early release
62should not be done within a week of the previous release.
63
64This, to enable us to collect and bundle more fixes into the same release to
65make the release more worthwhile for everyone and to allow more time for fixes
66to settle and things to get tested. Getting a release in shape and done in
67style is work that should not be rushed.
68