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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>How To Release LLVM To The Public — LLVM 13 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/llvm-theme.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Advice on Packaging LLVM" href="Packaging.html" />
<link rel="prev" title="Creating an LLVM Project" href="Projects.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head><body>
<div class="logo">
<a href="index.html">
<img src="_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="Packaging.html" title="Advice on Packaging LLVM"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Projects.html" title="Creating an LLVM Project"
accesskey="P">previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="GettingInvolved.html" accesskey="U">Getting Involved</a> »</li>
<li class="nav-item nav-item-this"><a href="">How To Release LLVM To The Public</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Documentation</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>
<h3>Getting Involved</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/Contributing.html">Contributing to LLVM</a></li>
<li><a href="https://llvm.org/docs/HowToSubmitABug.html">Submitting Bug Reports</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#mailing-lists">Mailing Lists</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#irc">IRC</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#meetups-and-social-events">Meetups and Social Events</a></li>
</ul>
<h3>Additional Links</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
<li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
<li><a href="https://llvm.org/pubs">Publications</a></li>
<li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/HowToReleaseLLVM.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="how-to-release-llvm-to-the-public">
<h1>How To Release LLVM To The Public<a class="headerlink" href="#how-to-release-llvm-to-the-public" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>This document contains information about successfully releasing LLVM —
including sub-projects: e.g., <code class="docutils literal notranslate"><span class="pre">clang</span></code> and <code class="docutils literal notranslate"><span class="pre">compiler-rt</span></code> — to the public.
It is the Release Manager’s responsibility to ensure that a high quality build
of LLVM is released.</p>
<p>If you’re looking for the document on how to test the release candidates and
create the binary packages, please refer to the <a class="reference internal" href="ReleaseProcess.html"><span class="doc">How To Validate a New Release</span></a> instead.</p>
</div>
<div class="section" id="release-timeline">
<span id="timeline"></span><h2>Release Timeline<a class="headerlink" href="#release-timeline" title="Permalink to this headline">¶</a></h2>
<p>LLVM is released on a time based schedule — with major releases roughly
every 6 months. In between major releases there may be dot releases.
The release manager will determine if and when to make a dot release based
on feedback from the community. Typically, dot releases should be made if
there are large number of bug-fixes in the stable branch or a critical bug
has been discovered that affects a large number of users.</p>
<p>Unless otherwise stated, dot releases will follow the same procedure as
major releases.</p>
<p>The release process is roughly as follows:</p>
<ul class="simple">
<li><p>Set code freeze and branch creation date for 6 months after last code freeze
date. Announce release schedule to the LLVM community and update the website.</p></li>
<li><p>Create release branch and begin release process.</p></li>
<li><p>Send out release candidate sources for first round of testing. Testing lasts
7-10 days. During the first round of testing, any regressions found should be
fixed. Patches are merged from mainline into the release branch. Also, all
features need to be completed during this time. Any features not completed at
the end of the first round of testing will be removed or disabled for the
release.</p></li>
<li><p>Generate and send out the second release candidate sources. Only <em>critical</em>
bugs found during this testing phase will be fixed. Any bugs introduced by
merged patches will be fixed. If so a third round of testing is needed.</p></li>
<li><p>The release notes are updated.</p></li>
<li><p>Finally, release!</p></li>
<li><p>Announce bug fix release schedule to the LLVM community and update the website.</p></li>
<li><p>Tag bug fix -rc1 after 4 weeks have passed.</p></li>
<li><p>Tag bug fix -rc2 4 weeks after -rc1.</p></li>
<li><p>Tag additional -rc candidates, if needed, to fix critical issues in
previous -rc releases.</p></li>
<li><p>Tag final release.</p></li>
</ul>
</div>
<div class="section" id="release-process">
<h2>Release Process<a class="headerlink" href="#release-process" title="Permalink to this headline">¶</a></h2>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#release-administrative-tasks" id="id1">Release Administrative Tasks</a></p>
<ul>
<li><p><a class="reference internal" href="#create-release-branch" id="id2">Create Release Branch</a></p></li>
<li><p><a class="reference internal" href="#update-llvm-version" id="id3">Update LLVM Version</a></p></li>
<li><p><a class="reference internal" href="#tagging-the-llvm-release-candidates" id="id4">Tagging the LLVM Release Candidates</a></p></li>
<li><p><a class="reference internal" href="#build-the-binary-distribution" id="id5">Build The Binary Distribution</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#release-qualification-criteria" id="id6">Release Qualification Criteria</a></p></li>
<li><p><a class="reference internal" href="#official-testing" id="id7">Official Testing</a></p></li>
<li><p><a class="reference internal" href="#community-testing" id="id8">Community Testing</a></p></li>
<li><p><a class="reference internal" href="#reporting-regressions" id="id9">Reporting Regressions</a></p></li>
<li><p><a class="reference internal" href="#merge-requests" id="id10">Merge Requests</a></p></li>
<li><p><a class="reference internal" href="#release-patch-rules" id="id11">Release Patch Rules</a></p>
<ul>
<li><p><a class="reference internal" href="#merging-patches" id="id12">Merging Patches</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#release-final-tasks" id="id13">Release Final Tasks</a></p>
<ul>
<li><p><a class="reference internal" href="#update-documentation" id="id14">Update Documentation</a></p></li>
<li><p><a class="reference internal" href="#tag-the-llvm-final-release" id="id15">Tag the LLVM Final Release</a></p></li>
<li><p><a class="reference internal" href="#update-the-llvm-website" id="id16">Update the LLVM Website</a></p></li>
<li><p><a class="reference internal" href="#announce-the-release" id="id17">Announce the Release</a></p></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="release-administrative-tasks">
<h3><a class="toc-backref" href="#id1">Release Administrative Tasks</a><a class="headerlink" href="#release-administrative-tasks" title="Permalink to this headline">¶</a></h3>
<p>This section describes a few administrative tasks that need to be done for the
release process to begin. Specifically, it involves:</p>
<ul class="simple">
<li><p>Updating version numbers,</p></li>
<li><p>Creating the release branch, and</p></li>
<li><p>Tagging release candidates for the release team to begin testing.</p></li>
</ul>
<div class="section" id="create-release-branch">
<h4><a class="toc-backref" href="#id2">Create Release Branch</a><a class="headerlink" href="#create-release-branch" title="Permalink to this headline">¶</a></h4>
<p>Branch the Git trunk using the following procedure:</p>
<ol class="arabic simple">
<li><p>Remind developers that the release branching is imminent and to refrain from
committing patches that might break the build. E.g., new features, large
patches for works in progress, an overhaul of the type system, an exciting
new TableGen feature, etc.</p></li>
<li><p>Verify that the current git trunk is in decent shape by
examining nightly tester and buildbot results.</p></li>
<li><p>Bump the version in trunk to N.0.0git and tag the commit with llvmorg-N-init.
If <code class="docutils literal notranslate"><span class="pre">X</span></code> is the version to be released, then <code class="docutils literal notranslate"><span class="pre">N</span></code> is <code class="docutils literal notranslate"><span class="pre">X</span> <span class="pre">+</span> <span class="pre">1</span></code>.</p></li>
</ol>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git tag -a llvmorg-N-init
</pre></div>
</div>
<ol class="arabic simple">
<li><p>Clear the release notes in trunk.</p></li>
<li><p>Create the release branch from the last known good revision from before the
version bump. The branch’s name is release/X.x where <code class="docutils literal notranslate"><span class="pre">X</span></code> is the major version
number and <code class="docutils literal notranslate"><span class="pre">x</span></code> is just the letter <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
<li><p>All tags and branches need to be created in both the llvm/llvm-project and
llvm/llvm-test-suite repos.</p></li>
</ol>
</div>
<div class="section" id="update-llvm-version">
<h4><a class="toc-backref" href="#id3">Update LLVM Version</a><a class="headerlink" href="#update-llvm-version" title="Permalink to this headline">¶</a></h4>
<p>After creating the LLVM release branch, update the release branches’
<code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> versions from ‘<code class="docutils literal notranslate"><span class="pre">X.0.0git</span></code>’ to ‘<code class="docutils literal notranslate"><span class="pre">X.0.0</span></code>’.</p>
<p>In addition, the version numbers of all the Bugzilla components must be updated
for the next release.</p>
</div>
<div class="section" id="tagging-the-llvm-release-candidates">
<h4><a class="toc-backref" href="#id4">Tagging the LLVM Release Candidates</a><a class="headerlink" href="#tagging-the-llvm-release-candidates" title="Permalink to this headline">¶</a></h4>
<p>Tag release candidates:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git tag -a llvmorg-X.Y.Z-rcN
</pre></div>
</div>
<p>The Release Manager must supply pre-packaged source tarballs for users. This can
be done with the export.sh script in utils/release.</p>
<p>Tarballs, release binaries, or any other release artifacts must be uploaded to
GitHub. This can be done using the github-upload-release.py script in utils/release.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ github-upload-release.py upload --token <github-token> --release X.Y.Z-rcN --files <release_files>
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./export.sh -release X.Y.Z -rc $RC
</pre></div>
</div>
<p>This will generate source tarballs for each LLVM project being validated, which
can be uploaded to github for further testing.</p>
</div>
<div class="section" id="build-the-binary-distribution">
<h4><a class="toc-backref" href="#id5">Build The Binary Distribution</a><a class="headerlink" href="#build-the-binary-distribution" title="Permalink to this headline">¶</a></h4>
<p>Creating the binary distribution requires following the instructions
<a class="reference internal" href="ReleaseProcess.html"><span class="doc">here</span></a>.</p>
<p>That process will perform both Release+Asserts and Release builds but only
pack the Release build for upload. You should use the Release+Asserts sysroot,
normally under <code class="docutils literal notranslate"><span class="pre">final/Phase3/Release+Asserts/llvmCore-3.8.1-RCn.install/</span></code>,
for test-suite and run-time benchmarks, to make sure nothing serious has
passed through the net. For compile-time benchmarks, use the Release version.</p>
<p>The minimum required version of the tools you’ll need are <a class="reference internal" href="GettingStarted.html"><span class="doc">here</span></a></p>
</div>
</div>
<div class="section" id="release-qualification-criteria">
<h3><a class="toc-backref" href="#id6">Release Qualification Criteria</a><a class="headerlink" href="#release-qualification-criteria" title="Permalink to this headline">¶</a></h3>
<p>There are no official release qualification criteria. It is up to the
the release manager to determine when a release is ready. The release manager
should pay attention to the results of community testing, the number of outstanding
bugs, and then number of regressions when determining whether or not to make a
release.</p>
<p>The community values time based releases, so releases should not be delayed for
too long unless there are critical issues remaining. In most cases, the only
kind of bugs that are critical enough to block a release would be a major regression
from a previous release.</p>
</div>
<div class="section" id="official-testing">
<h3><a class="toc-backref" href="#id7">Official Testing</a><a class="headerlink" href="#official-testing" title="Permalink to this headline">¶</a></h3>
<p>A few developers in the community have dedicated time to validate the release
candidates and volunteered to be the official release testers for each
architecture.</p>
<p>These will be the ones testing, generating and uploading the official binaries
to the server, and will be the minimum tests <em>necessary</em> for the release to
proceed.</p>
<p>This will obviously not cover all OSs and distributions, so additional community
validation is important. However, if community input is not reached before the
release is out, all bugs reported will have to go on the next stable release.</p>
<p>The official release managers are:</p>
<ul class="simple">
<li><p>Major releases (X.0): Hans Wennborg</p></li>
<li><p>Stable releases (X.n): Tom Stellard</p></li>
</ul>
<p>The official release testers are volunteered from the community and have
consistently validated and released binaries for their targets/OSs. To contact
them, you should email the <code class="docutils literal notranslate"><span class="pre">release-testers@lists.llvm.org</span></code> mailing list.</p>
<p>The official testers list is in the file <code class="docutils literal notranslate"><span class="pre">RELEASE_TESTERS.TXT</span></code>, in the <code class="docutils literal notranslate"><span class="pre">LLVM</span></code>
repository.</p>
</div>
<div class="section" id="community-testing">
<h3><a class="toc-backref" href="#id8">Community Testing</a><a class="headerlink" href="#community-testing" title="Permalink to this headline">¶</a></h3>
<p>Once all testing has been completed and appropriate bugs filed, the release
candidate tarballs are put on the website and the LLVM community is notified.</p>
<p>We ask that all LLVM developers test the release in any the following ways:</p>
<ol class="arabic simple">
<li><p>Download <code class="docutils literal notranslate"><span class="pre">llvm-X.Y</span></code>, <code class="docutils literal notranslate"><span class="pre">llvm-test-X.Y</span></code>, and the appropriate <code class="docutils literal notranslate"><span class="pre">clang</span></code>
binary. Build LLVM. Run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">check</span></code> and the full LLVM test suite (<code class="docutils literal notranslate"><span class="pre">make</span>
<span class="pre">TEST=nightly</span> <span class="pre">report</span></code>).</p></li>
<li><p>Download <code class="docutils literal notranslate"><span class="pre">llvm-X.Y</span></code>, <code class="docutils literal notranslate"><span class="pre">llvm-test-X.Y</span></code>, and the <code class="docutils literal notranslate"><span class="pre">clang</span></code> sources. Compile
everything. Run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">check</span></code> and the full LLVM test suite (<code class="docutils literal notranslate"><span class="pre">make</span>
<span class="pre">TEST=nightly</span> <span class="pre">report</span></code>).</p></li>
<li><p>Download <code class="docutils literal notranslate"><span class="pre">llvm-X.Y</span></code>, <code class="docutils literal notranslate"><span class="pre">llvm-test-X.Y</span></code>, and the appropriate <code class="docutils literal notranslate"><span class="pre">clang</span></code>
binary. Build whole programs with it (ex. Chromium, Firefox, Apache) for
your platform.</p></li>
<li><p>Download <code class="docutils literal notranslate"><span class="pre">llvm-X.Y</span></code>, <code class="docutils literal notranslate"><span class="pre">llvm-test-X.Y</span></code>, and the appropriate <code class="docutils literal notranslate"><span class="pre">clang</span></code>
binary. Build <em>your</em> programs with it and check for conformance and
performance regressions.</p></li>
<li><p>Run the <a class="reference internal" href="ReleaseProcess.html"><span class="doc">release process</span></a>, if your platform is
<em>different</em> than that which is officially supported, and report back errors
only if they were not reported by the official release tester for that
architecture.</p></li>
</ol>
<p>We also ask that the OS distribution release managers test their packages with
the first candidate of every release, and report any <em>new</em> errors in Bugzilla.
If the bug can be reproduced with an unpatched upstream version of the release
candidate (as opposed to the distribution’s own build), the priority should be
release blocker.</p>
<p>During the first round of testing, all regressions must be fixed before the
second release candidate is tagged.</p>
<p>In the subsequent stages, the testing is only to ensure that bug
fixes previously merged in have not created new major problems. <em>This is not
the time to solve additional and unrelated bugs!</em> If no patches are merged in,
the release is determined to be ready and the release manager may move onto the
next stage.</p>
</div>
<div class="section" id="reporting-regressions">
<h3><a class="toc-backref" href="#id9">Reporting Regressions</a><a class="headerlink" href="#reporting-regressions" title="Permalink to this headline">¶</a></h3>
<p>Every regression that is found during the tests (as per the criteria above),
should be filled in a bug in Bugzilla with the priority <em>release blocker</em> and
blocking a specific release.</p>
<p>To help manage all the bugs reported and which ones are blockers or not, a new
“[meta]” bug should be created and all regressions <em>blocking</em> that Meta. Once
all blockers are done, the Meta can be closed.</p>
<p>If a bug can’t be reproduced, or stops being a blocker, it should be removed
from the Meta and its priority decreased to <em>normal</em>. Debugging can continue,
but on trunk.</p>
</div>
<div class="section" id="merge-requests">
<h3><a class="toc-backref" href="#id10">Merge Requests</a><a class="headerlink" href="#merge-requests" title="Permalink to this headline">¶</a></h3>
<p>You can use any of the following methods to request that a revision from trunk
be merged into a release branch:</p>
<ol class="arabic simple">
<li><p>Use the <code class="docutils literal notranslate"><span class="pre">utils/release/merge-request.sh</span></code> script which will automatically
file a <a class="reference external" href="https://bugs.llvm.org/">bug</a> requesting that the patch be merged. e.g. To request revision
12345 be merged into the branch for the 5.0.1 release:
<code class="docutils literal notranslate"><span class="pre">llvm.src/utils/release/merge-request.sh</span> <span class="pre">-stable-version</span> <span class="pre">5.0</span> <span class="pre">-r</span> <span class="pre">12345</span> <span class="pre">-user</span> <span class="pre">bugzilla@example.com</span></code></p></li>
<li><p>Manually file a <a class="reference external" href="https://bugs.llvm.org/">bug</a> with the subject: “Merge r12345 into the X.Y branch”,
enter the commit(s) that you want merged in the “Fixed by Commit(s)” and mark
it as a blocker of the current release bug. Release bugs are given aliases
in the form of release-x.y.z, so to mark a bug as a blocker for the 5.0.1
release, just enter release-5.0.1 in the “Blocks” field.</p></li>
<li><p>Reply to the commit email on llvm-commits for the revision to merge and cc
the release manager.</p></li>
</ol>
</div>
<div class="section" id="release-patch-rules">
<h3><a class="toc-backref" href="#id11">Release Patch Rules</a><a class="headerlink" href="#release-patch-rules" title="Permalink to this headline">¶</a></h3>
<p>Below are the rules regarding patching the release branch:</p>
<ol class="arabic simple">
<li><p>Patches applied to the release branch may only be applied by the release
manager, the official release testers or the code owners with approval from
the release manager.</p></li>
<li><p>Release managers are encouraged, but not required, to get approval from code
owners before approving patches. If there is no code owner or the code owner
is unreachable then release managers can ask approval from patch reviewers or
other developers active in that area.</p></li>
<li><p><em>Before RC1</em> Patches should be limited to bug fixes, important optimization
improvements, or completion of features that were started before the branch
was created. As with all phases, release managers and code owners can reject
patches that are deemed too invasive.</p></li>
<li><p><em>Before RC2</em> Patches should be limited to bug fixes or backend specific
improvements that are determined to be very safe.</p></li>
<li><p><em>Before RC3/Final Major Release</em> Patches should be limited to critical
bugs or regressions.</p></li>
<li><p><em>Bug fix releases</em> Patches should be limited to bug fixes or very safe
and critical performance improvements. Patches must maintain both API and
ABI compatibility with the previous major release.</p></li>
</ol>
<div class="section" id="merging-patches">
<h4><a class="toc-backref" href="#id12">Merging Patches</a><a class="headerlink" href="#merging-patches" title="Permalink to this headline">¶</a></h4>
<p>Use the <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">cherry-pick</span> <span class="pre">-x</span></code> command to merge patches to the release branch:</p>
<ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">cherry-pick</span> <span class="pre">-x</span> <span class="pre">abcdef0</span></code></p></li>
<li><p>Run regression tests.</p></li>
</ol>
</div>
</div>
<div class="section" id="release-final-tasks">
<h3><a class="toc-backref" href="#id13">Release Final Tasks</a><a class="headerlink" href="#release-final-tasks" title="Permalink to this headline">¶</a></h3>
<p>The final stages of the release process involves tagging the “final” release
branch, updating documentation that refers to the release, and updating the
demo page.</p>
<div class="section" id="update-documentation">
<h4><a class="toc-backref" href="#id14">Update Documentation</a><a class="headerlink" href="#update-documentation" title="Permalink to this headline">¶</a></h4>
<p>Review the documentation in the release branch and ensure that it is up
to date. The “Release Notes” must be updated to reflect new features, bug
fixes, new known issues, and changes in the list of supported platforms.
The “Getting Started Guide” should be updated to reflect the new release
version number tag available from Subversion and changes in basic system
requirements.</p>
</div>
<div class="section" id="tag-the-llvm-final-release">
<span id="tag"></span><h4><a class="toc-backref" href="#id15">Tag the LLVM Final Release</a><a class="headerlink" href="#tag-the-llvm-final-release" title="Permalink to this headline">¶</a></h4>
<p>Tag the final release sources:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git tag -a llvmorg-X.Y.Z
$ git push https://github.com/llvm/llvm-project.git llvmorg-X.Y.Z
</pre></div>
</div>
</div>
<div class="section" id="update-the-llvm-website">
<h4><a class="toc-backref" href="#id16">Update the LLVM Website</a><a class="headerlink" href="#update-the-llvm-website" title="Permalink to this headline">¶</a></h4>
<p>The website must be updated before the release announcement is sent out. Here
is what to do:</p>
<ol class="arabic simple">
<li><p>Check out the <code class="docutils literal notranslate"><span class="pre">www-releases</span></code> module from GitHub.</p></li>
<li><p>Create a new sub-directory <code class="docutils literal notranslate"><span class="pre">X.Y.Z</span></code> in the releases directory.</p></li>
<li><p>Copy and commit the <code class="docutils literal notranslate"><span class="pre">llvm/docs</span></code> and <code class="docutils literal notranslate"><span class="pre">LICENSE.txt</span></code> files into this new
directory.</p></li>
<li><p>Update the <code class="docutils literal notranslate"><span class="pre">releases/download.html</span></code> file with links to the release
binaries on GitHub.</p></li>
<li><p>Update the <code class="docutils literal notranslate"><span class="pre">releases/index.html</span></code> with the new release and link to release
documentation.</p></li>
<li><p>Finally checkout the llvm-www repo and update the main page
(<code class="docutils literal notranslate"><span class="pre">index.html</span></code> and sidebar) to point to the new release and release
announcement.</p></li>
</ol>
</div>
<div class="section" id="announce-the-release">
<h4><a class="toc-backref" href="#id17">Announce the Release</a><a class="headerlink" href="#announce-the-release" title="Permalink to this headline">¶</a></h4>
<p>Send an email to the list announcing the release, pointing people to all the
relevant documentation, download pages and bugs fixed.</p>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="Packaging.html" title="Advice on Packaging LLVM"
>next</a> |</li>
<li class="right" >
<a href="Projects.html" title="Creating an LLVM Project"
>previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="GettingInvolved.html" >Getting Involved</a> »</li>
<li class="nav-item nav-item-this"><a href="">How To Release LLVM To The Public</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2003-2021, LLVM Project.
Last updated on 2021-09-18.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
</body>
</html>
|
