forked from pantsbuild/pantsbuild.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
release_strategy.html
431 lines (409 loc) · 22.3 KB
/
release_strategy.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
<!DOCTYPE html>
<html lang="en">
<!--
Copyright 2014 Pants project contributors (see CONTRIBUTORS.md).
Licensed under the Apache License, Version 2.0 (see LICENSE).
-->
<head>
<meta charset="utf-8"/>
<title>Release Strategy</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="pants-logo.ico">
<!-- In case this is a "test publish", tell search engines where real version lives: -->
<link rel="canonical" href="http://pantsbuild.org/release_strategy.html">
<link rel="stylesheet" href="bootstrap-custom.min.css">
<link rel="stylesheet" href="bootstrap-custom-theme.min.css">
<link rel="stylesheet" href="docsite.css">
</head>
<body>
<div class="header">
<nav class="navbar navbar-default navbar-static-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand navbar-brand-img" href="index.html">
<img src="pants-logo.ico" alt="[pantsbuild logo]">
</a>
<a class="navbar-brand" href="index.html">
Pants
</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="/">Docs</a></li>
<li><a href="community.html">Community</a></li>
<li><a href="https://www.github.com/pantsbuild/pants">GitHub</a></li>
<li>
<form class="navbar-form navbar-left search" role="search" action="https://www.google.com/search">
<div class="form-group">
<input type="text" name="as_q" class="form-control query" placeholder="Search">
<input name="as_sitesearch" value="pantsbuild.org" type="hidden">
</div>
</form>
</li>
</ul>
</div><!--/.nav-collapse -->
</div>
</nav>
</div>
<div class="page">
<div class="container-fluid">
<div class="row">
<div class="col-md-1">
</div>
<div class="col-md-2">
<div class="site-toc">
<ul>
<li class="toc-h1 toc-heading">
Getting Started
</li>
<li class="toc-h1 toc-link ">
<a href="install.html">Installing Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="setup_repo.html">Setting Up Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="first_tutorial.html">Tutorial</a>
</li>
<li class="toc-h1 toc-link ">
<a href="common_tasks.html">Common Tasks</a>
</li>
<li class="toc-h1 toc-heading">
Pants Basics
</li>
<li class="toc-h1 toc-link ">
<a href="why_use_pants.html">Why Use Pants?</a>
</li>
<li class="toc-h1 toc-link ">
<a href="first_concepts.html">Pants Concepts</a>
</li>
<li class="toc-h1 toc-link ">
<a href="build_files.html">BUILD files</a>
</li>
<li class="toc-h1 toc-link ">
<a href="target_addresses.html">Target Addresses</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty.html">Third-Party Dependencies</a>
</li>
<li class="toc-h1 toc-link ">
<a href="options.html">Pants Options</a>
</li>
<li class="toc-h1 toc-link ">
<a href="invoking.html">Invoking Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="reporting_server.html">Reporting Server</a>
</li>
<li class="toc-h1 toc-link ">
<a href="ide_support.html">IDE Support</a>
</li>
<li class="toc-h1 toc-heading">
JVM
</li>
<li class="toc-h1 toc-link ">
<a href="jvm_projects.html">JVM Projects with Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty_jvm.html">JVM 3rdparty Pattern</a>
</li>
<li class="toc-h1 toc-link ">
<a href="scala.html">Scala Support</a>
</li>
<li class="toc-h1 toc-link ">
<a href="publish.html">Publishing Artifacts</a>
</li>
<li class="toc-h1 toc-link ">
<a href="from_maven.html">Pants for Maven Experts</a>
</li>
<li class="toc-h1 toc-heading">
Python
</li>
<li class="toc-h1 toc-link ">
<a href="python_readme.html">Python Projects with Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty_py.html">Python 3rdparty Pattern</a>
</li>
<li class="toc-h1 toc-heading">
Go
</li>
<li class="toc-h1 toc-link ">
<a href="go_readme.html">Go support for Pants</a>
</li>
<li class="toc-h1 toc-heading">
Codegen
</li>
<li class="toc-h1 toc-link ">
<a href="thrift_deps.html">Thrift</a>
</li>
<li class="toc-h1 toc-heading">
Docgen
</li>
<li class="toc-h1 toc-link ">
<a href="page.html">Markdown</a>
</li>
<li class="toc-h1 toc-heading">
Getting Help
</li>
<li class="toc-h1 toc-link ">
<a href="tshoot.html">Troubleshooting</a>
</li>
<li class="toc-h1 toc-link ">
<a href="community.html">Community</a>
</li>
<li class="toc-h1 toc-heading">
Reference
</li>
<li class="toc-h1 toc-link ">
<a href="build_dictionary.html">Pants BUILD Dictionary</a>
</li>
<li class="toc-h1 toc-link ">
<a href="options_reference.html">Pants Reference</a>
</li>
<li class="toc-h1 toc-heading">
Release Notes
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.3.x.html">1.3.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.2.x.html">1.2.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.1.x.html">1.1.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.0.x.html">1.0.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-master.html">Master Pre-Releases</a>
</li>
<li class="toc-h1 toc-heading">
Developer
</li>
<li class="toc-h1 toc-link ">
<a href="dev.html">Pants Developer Center</a>
</li>
<li class="toc-h1 toc-link ">
<a href="export.html">Export Format</a>
</li>
</ul>
</div> <!-- site-toc -->
</div>
<div class="col-md-8">
<div class="content">
<div class="mainflow">
<nav class="pagetoc">
<ul>
<li class="toc-h1"><a href="#release-responsibilities">Release Responsibilities</a></li>
<li class="toc-h1"><a href="#release-cadence">Release Cadence</a></li>
<li class="toc-h1"><a href="#release-types">Release Types</a></li>
<li class="toc-h2"><a href="#dev-releases">dev releases</a></li>
<li class="toc-h2"><a href="#stable-releases">stable releases</a></li>
<li class="toc-h3"><a href="#major-and-minor-stable-branches">major and minor stable branches</a></li>
<li class="toc-h3"><a href="#patch-stable-releases">patch stable Releases</a></li>
<li class="toc-h1"><a href="#naming-conventions">Naming conventions</a></li>
<li class="toc-h2"><a href="#stable-naming">stable naming</a></li>
<li class="toc-h2"><a href="#dev-naming">dev naming</a></li>
<li class="toc-h1"><a href="#examples">Examples</a></li>
<li class="toc-h1"><a href="#stable-release-candidates">stable Release Candidates</a></li>
</ul>
</nav>
<!-- main content start -->
<!-- generated by pants! -->
<style>
.codehilite .hll { background-color: #ffffcc }
.codehilite { background: #f0f0f0; }
.codehilite .c { color: #60a0b0; font-style: italic } /* Comment */
.codehilite .err { border: 1px solid #FF0000 } /* Error */
.codehilite .k { color: #007020; font-weight: bold } /* Keyword */
.codehilite .o { color: #666666 } /* Operator */
.codehilite .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */
.codehilite .cp { color: #007020 } /* Comment.Preproc */
.codehilite .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */
.codehilite .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
.codehilite .gd { color: #A00000 } /* Generic.Deleted */
.codehilite .ge { font-style: italic } /* Generic.Emph */
.codehilite .gr { color: #FF0000 } /* Generic.Error */
.codehilite .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.codehilite .gi { color: #00A000 } /* Generic.Inserted */
.codehilite .go { color: #808080 } /* Generic.Output */
.codehilite .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.codehilite .gs { font-weight: bold } /* Generic.Strong */
.codehilite .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.codehilite .gt { color: #0040D0 } /* Generic.Traceback */
.codehilite .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.codehilite .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.codehilite .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.codehilite .kp { color: #007020 } /* Keyword.Pseudo */
.codehilite .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.codehilite .kt { color: #902000 } /* Keyword.Type */
.codehilite .m { color: #40a070 } /* Literal.Number */
.codehilite .s { color: #4070a0 } /* Literal.String */
.codehilite .na { color: #4070a0 } /* Name.Attribute */
.codehilite .nb { color: #007020 } /* Name.Builtin */
.codehilite .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.codehilite .no { color: #60add5 } /* Name.Constant */
.codehilite .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.codehilite .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.codehilite .ne { color: #007020 } /* Name.Exception */
.codehilite .nf { color: #06287e } /* Name.Function */
.codehilite .nl { color: #002070; font-weight: bold } /* Name.Label */
.codehilite .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.codehilite .nt { color: #062873; font-weight: bold } /* Name.Tag */
.codehilite .nv { color: #bb60d5 } /* Name.Variable */
.codehilite .ow { color: #007020; font-weight: bold } /* Operator.Word */
.codehilite .w { color: #bbbbbb } /* Text.Whitespace */
.codehilite .mf { color: #40a070 } /* Literal.Number.Float */
.codehilite .mh { color: #40a070 } /* Literal.Number.Hex */
.codehilite .mi { color: #40a070 } /* Literal.Number.Integer */
.codehilite .mo { color: #40a070 } /* Literal.Number.Oct */
.codehilite .sb { color: #4070a0 } /* Literal.String.Backtick */
.codehilite .sc { color: #4070a0 } /* Literal.String.Char */
.codehilite .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.codehilite .s2 { color: #4070a0 } /* Literal.String.Double */
.codehilite .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.codehilite .sh { color: #4070a0 } /* Literal.String.Heredoc */
.codehilite .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.codehilite .sx { color: #c65d09 } /* Literal.String.Other */
.codehilite .sr { color: #235388 } /* Literal.String.Regex */
.codehilite .s1 { color: #4070a0 } /* Literal.String.Single */
.codehilite .ss { color: #517918 } /* Literal.String.Symbol */
.codehilite .bp { color: #007020 } /* Name.Builtin.Pseudo */
.codehilite .vc { color: #bb60d5 } /* Name.Variable.Class */
.codehilite .vg { color: #bb60d5 } /* Name.Variable.Global */
.codehilite .vi { color: #bb60d5 } /* Name.Variable.Instance */
.codehilite .il { color: #40a070 } /* Literal.Number.Integer.Long */
</style>
<h1 id="release-strategy">Release Strategy</h1>
<p>This page describes the "who", "what", and "when" of Pants releases. If you're interested
in learning "how" to release, see the <a href="release.html">Release Process</a> page.</p>
<h2 id="release-responsibilities">Release Responsibilities</h2>
<p>There is one release manager per week, decided via a shared calendar (to volunteer to be added
to the calendar, see <a href="howto_contribute.html">How to Contribute</a>).</p>
<p>The release manager is responsible for:</p>
<ul>
<li>Creating <code>stable</code> branches</li>
<li>Creating and gathering feedback on release candidates</li>
<li>Cutting <code>dev</code> and <code>stable</code> releases</li>
</ul>
<p>These release types and responsibilities are described below.</p>
<h2 id="release-cadence">Release Cadence</h2>
<p>The release manager for a particular week decides whether to cut <code>stable</code> release. A <code>dev</code> release
or <code>rc</code> release from master should happen every week. Stable branches will be created based on the
following criteria:</p>
<ol>
<li>Decide whether to create a <em>new</em> <code>stable</code> branch:<ul>
<li>If it has been approximately <a href="deprecation_policy.html">three months</a> since the
previous <code>stable</code> branch, the release manager should inspect changes that have landed in master
since the previous <code>stable</code> branch was created, and decide whether the changes justify a new
<code>stable</code> branch (this is intentionally left open for discussion). If a new <code>stable</code> branch is
justified, it will be either a <code>major</code> or <code>minor</code> branch (described below).</li>
<li>If a new <code>stable</code> branch is <em>not</em> created (because of insufficient time/change to justify the
stable vetting process), the release manager must cut a <code>dev</code> release from master instead.</li>
</ul>
</li>
<li>In addition to any <code>dev</code> release or newly-created <code>stable</code> branches, the release manager should
determine whether any existing <code>stable</code> branches need new release candidates by looking for
<a href="https://github.com/pantsbuild/pants/pulls?q=is%3Apr+label%3Aneeds-rc-cherrypick">changes labelled needs-rc-cherrypick</a>.
If there are requests "sufficient" to justify <code>patch</code> releases for existing <code>stable</code> branches, the
release manager should cut release candidates for those branches.</li>
</ol>
<p>In other words, for a given week: <em>one of either</em> a <code>dev</code> or <code>rc</code> release will be created from
master. A new <code>stable</code> branch may be created, and additionally, <code>patch</code> releases for
existing <code>stable</code> branches <em>might</em> be created.</p>
<h2 id="release-types">Release Types</h2>
<h3 id="dev-releases"><code>dev</code> releases</h3>
<p><code>dev</code> releases are releases that occur directly from master, without the additional vetting that
is applied to <code>stable</code> releases. They help to ensure a steady release cadence from master by filling
in the gaps between the (generally more time consuming) <code>stable</code> releases.</p>
<h3 id="stable-releases"><code>stable</code> releases</h3>
<p><code>stable</code> release candidates generally happen every two weeks, provided that there are enough user
facing changes to warrant a new <code>stable</code> release. Of those two weeks, five business days are allocated
to bugfixing and testing by pants contributors on a release candidate announcement thread (described
below). If any changes are needed to the stable release based on feedback a new <code>rc</code> release will
be created for the stable branch.</p>
<h4 id="major-and-minor-stable-branches"><code>major</code> and <code>minor</code> stable branches</h4>
<p>The decision to create a <code>major</code> or a <code>minor</code> stable branch is based on consensus on
<a href="howto_contribute.html">pants-devel@</a> as to the impact of the changes.
<code>major</code> releases signify large or breaking changes. <code>minor</code> releases however should be compatible
with the last two <code>minor</code> releases. In other words if a feature is deprecated in version <code>1.2.x</code>
you should be able to continue using that feature at least through version <code>1.4.0</code>.</p>
<h4 id="patch-stable-releases"><code>patch</code> stable Releases</h4>
<p>In order to allow us to react quickly to bugs, <code>patch</code> fixes are released for <code>stable</code> branches as
needed and should always consist of fixes or small backwards-compatible features backported from
master. These releases update the patch version number, (ie, from <code>1.0.x</code> to <code>1.0.y</code>) and should
only include commits from the Pants Backport Proposals that are deemed to be
<a href="deprecation_policy.html">backwards compatible</a>.</p>
<h2 id="naming-conventions">Naming conventions</h2>
<h3 id="stable-naming"><code>stable</code> naming</h3>
<p>Leading up to a <code>stable</code> release, development work should be done on a branch named with the
following format: <code>n.n.x</code> where n.n are the <code>major</code>/<code>minor</code> version numbers and "<code>x</code>" is a literal
character placeholder for the <code>patch</code> version. Release candidates of an upcoming <code>stable</code> release
are suffixed with <code>rcN</code>. For instance: "the <code>1.1.x</code> <code>stable</code> branch",
"the <code>1.1.1rc0</code> release candidate", and "the <code>1.1.1</code> <code>stable</code> release".</p>
<h3 id="dev-naming"><code>dev</code> naming</h3>
<p><code>dev</code> releases occur between <code>stable</code> branches, and are differentiated by a <code>devN</code> suffix. The pattern
to follow is <code>N.N.0.devN</code>, where <code>N.N</code> are the <em>next</em> <code>major</code>/<code>minor</code> branch that will be created
and N is the next sequential number starting from <code>0</code>. For instance: "the <code>1.1.0.dev0</code> <code>dev</code> release".
Note the dot before the <code>dev0</code>. See https://www.python.org/dev/peps/pep-0440/#public-version-identifiers.</p>
<h2 id="examples">Examples</h2>
<ul>
<li>
<p>Leading up to the release of <code>2.0.0</code> the release manager would create a <code>stable</code> branch with
the literal name "<code>2.0.x</code>". They would cut release candidates named <code>2.0.0rc0</code> (and so on), and
afterwards, they'd finalize the <code>2.0.0</code> release in that <code>2.0.x</code> branch by tagging the
commit with the release version: <code>v2.0.0</code>.
Note the lack of a dot before the <code>rc0</code>. See https://www.python.org/dev/peps/pep-0440/#public-version-identifiers.</p>
</li>
<li>
<p>If a release manager had a bugfix from master that they needed to backport to the <code>1.1.x</code> <code>stable</code>
branch, they would cherry-pick the commit to the <code>1.1.x</code> branch, run a series of release candidates
(ie, <code>1.1.1rc0</code>, etc), and finally tag the validated commit with a new patch version (ie <code>v1.1.1</code>).</p>
</li>
<li>
<p>If <code>dev</code> releases were required after having created the <code>1.0.x</code> branch, but before having created
the <code>1.1.x</code> branch, then they would start with <code>1.1.0.dev0</code>, and continue weekly to <code>1.1.0.devN</code>
until the <code>1.1.x</code> branch had been created.</p>
</li>
</ul>
<h2 id="stable-release-candidates"><code>stable</code> Release Candidates</h2>
<p>In order to make a <code>stable</code> release, the release manager needs to create a release candidate for
contributors to test. Once a release candidate has been created and announced according to the
<a href="release.html">Release Process</a>, the release manager should allow five business days
for contributors to raise concerns on the release candidate announcement thread. During those five
days the release manager might need to perform multiple release candidates, until finally, when no
more blockers are raised against a particular release candidate, the final version of that release
can be cut.</p>
<!-- main content end -->
<div class="generated">
Generated by <a href="docs.html">publish_docs</a>
from dist/markdown/html/src/docs/release_strategy.html 2017-05-29T10:30:51.015976
</div>
</div> <!-- mainflow -->
</div> <!-- content -->
</div>
<div class="col-md-1">
</div>
</div> <!-- row -->
</div> <!-- container-fluid -->
</div> <!-- page -->
<script src="https://code.jquery.com/jquery-2.2.3.min.js" integrity="sha384-I6F5OKECLVtK/BL+8iSLDEHowSAfUo76ZL9+kGAgTRdiByINKJaqTPH/QVNS1VDb" crossorigin="anonymous"></script>
<script src="bootstrap-custom.min.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-78111411-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>