Skip to content

Commit cc42111

Browse files
committed
[llvm][docs] Minor fixes and improvements for release process
- The list numbering in [1] currently starts again after item 3 due to the code-block. - Remove mentions of Phabricator and Subversion. - In final step of [2] remove mention of llvm/utils/git/sync-release-repo.sh, which was removed in #73682. - Add direct links to: - www-releases repo. - backporting doc [3]. - Getting Started page. - RELEASE_TESTERS.txt. - Release Sources GitHub workflow. [1] https://llvm.org/docs/HowToReleaseLLVM.html#create-release-branch [2] https://llvm.org/docs/HowToReleaseLLVM.html#triaging-bug-reports-for-releases [3] https://llvm.org/docs/GitHub.html#backporting-fixes-to-the-release-branches
1 parent ef51514 commit cc42111

File tree

1 file changed

+24
-29
lines changed

1 file changed

+24
-29
lines changed

llvm/docs/HowToReleaseLLVM.rst

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -115,11 +115,9 @@ Branch the Git trunk using the following procedure:
115115
examining nightly tester and buildbot results.
116116

117117
#. Bump the version in trunk to N.0.0git and tag the commit with llvmorg-N-init.
118-
If ``X`` is the version to be released, then ``N`` is ``X + 1``.
118+
If ``X`` is the version to be released, then ``N`` is ``X + 1``. ::
119119

120-
::
121-
122-
$ git tag -sa llvmorg-N-init
120+
$ git tag -sa llvmorg-N-init
123121

124122
#. Clear the release notes in trunk.
125123

@@ -149,10 +147,12 @@ Tag release candidates:
149147
$ git tag -sa llvmorg-X.Y.Z-rcN
150148

151149
The pre-packaged source tarballs will be automatically generated via the
152-
"Release Sources" workflow on GitHub. This workflow will create an artifact
153-
containing all the release tarballs and the artifact attestation. The
154-
Release Manager should download the artifact, verify the tarballs, sign them,
155-
and then upload them to the release page.
150+
`Release Sources
151+
<https://github.com/llvm/llvm-project/actions/workflows/release-sources.yml>`_
152+
workflow on GitHub. This workflow will create an artifact containing all the
153+
release tarballs and the artifact attestation. The Release Manager should
154+
download the artifact, verify the tarballs, sign them, and then upload them to
155+
the release page.
156156

157157
::
158158

@@ -221,8 +221,9 @@ consistently validated and released binaries for their targets/OSs. To contact
221221
them, you should post on the `Discourse forums (Project
222222
Infrastructure - Release Testers). <https://discourse.llvm.org/c/infrastructure/release-testers/66>`_
223223

224-
The official testers list is in the file ``RELEASE_TESTERS.TXT``, in the ``LLVM``
225-
repository.
224+
The official testers list is in the file `RELEASE_TESTERS.TXT
225+
<https://github.com/llvm/llvm-project/blob/main/llvm/RELEASE_TESTERS.TXT>`_, in
226+
the LLVM repository.
226227

227228
Community Testing
228229
-----------------
@@ -280,7 +281,8 @@ from the Milestone. Debugging can continue, but on trunk.
280281
Backport Requests
281282
-----------------
282283

283-
Instructions for requesting a backport to a stable branch can be found :doc:`here <GitHub>`.
284+
Instructions for requesting a backport to a stable branch can be found
285+
:ref:`here <backporting>`.
284286

285287
Triaging Bug Reports for Releases
286288
---------------------------------
@@ -305,26 +307,19 @@ This section describes how to triage bug reports:
305307
using the /cherry-pick or /branch comments if this has not been done already.
306308

307309
#. If a bug has been fixed and has a pull request created for backporting it,
308-
then update its status to "Needs Review" and notify a knowledgeable reviewer.
309-
Usually you will want to notify the person who approved the patch in Phabricator,
310-
but you may use your best judgement on who a good reviewer would be. Once
311-
you have identified the reviewer(s), assign the issue to them and mention
312-
them (i.e @username) in a comment and ask them if the patch is safe to backport.
313-
You should also review the bug yourself to ensure that it meets the requirements
314-
for committing to the release branch.
310+
then update its status to "Needs Review" and notify a knowledgeable
311+
reviewer. Usually you will want to notify the person who approved the
312+
patch, but you may use your best judgement on who a good reviewer would be.
313+
Once you have identified the reviewer(s), assign the issue to them and
314+
mention them (i.e @username) in a comment and ask them if the patch is safe
315+
to backport. You should also review the bug yourself to ensure that it
316+
meets the requirements for committing to the release branch.
315317

316318
#. Once a bug has been reviewed, add the release:reviewed label and update the
317319
issue's status to "Needs Merge". Check the pull request associated with the
318320
issue. If all the tests pass, then the pull request can be merged. If not,
319321
then add a comment on the issue asking someone to take a look at the failures.
320322

321-
#. Once the pull request has been merged push it to the official release branch
322-
with the script ``llvm/utils/git/sync-release-repo.sh``.
323-
324-
Then add a comment to the issue stating that the fix has been merged along with
325-
the git hashes from the release branch. Add the release:merged label to the issue
326-
and close it.
327-
328323

329324
Release Patch Rules
330325
-------------------
@@ -368,9 +363,8 @@ Update Documentation
368363
Review the documentation in the release branch and ensure that it is up
369364
to date. The "Release Notes" must be updated to reflect new features, bug
370365
fixes, new known issues, and changes in the list of supported platforms.
371-
The "Getting Started Guide" should be updated to reflect the new release
372-
version number tag available from Subversion and changes in basic system
373-
requirements.
366+
The :doc:`GettingStarted` page should be updated to reflect the new release
367+
version number tag and changes in basic system requirements.
374368

375369
.. _tag:
376370

@@ -390,7 +384,8 @@ Update the LLVM Website
390384
The website must be updated before the release announcement is sent out. Here
391385
is what to do:
392386

393-
#. Check out the ``www-releases`` module from GitHub.
387+
#. Check out the `www-releases <https://github.com/llvm/www-releases>`_ repo
388+
from GitHub.
394389

395390
#. Create a new sub-directory ``X.Y.Z`` in the releases directory.
396391

0 commit comments

Comments
 (0)