Skip to content

Commit 913ae2d

Browse files
authored
[llvm][docs] Minor fixes and improvements for release process (llvm#151956)
- 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 llvm#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 93408f5 commit 913ae2d

File tree

1 file changed

+25
-30
lines changed

1 file changed

+25
-30
lines changed

llvm/docs/HowToReleaseLLVM.rst

Lines changed: 25 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -116,13 +116,11 @@ Branch the Git trunk using the following procedure:
116116

117117
#. Bump the version in trunk to N.0.0git with the script in
118118
``llvm/utils/release/bump-version.py``, and tag the commit with llvmorg-N-init.
119-
If ``X`` is the version to be released, then ``N`` is ``X + 1``.
119+
If ``X`` is the version to be released, then ``N`` is ``X + 1``. ::
120120

121-
::
122-
123-
$ git tag -sa llvmorg-N-init
121+
$ git tag -sa llvmorg-N-init
124122

125-
4. Clear the release notes in trunk with the script in
123+
#. Clear the release notes in trunk with the script in
126124
``llvm/utils/release/clear-release-notes.py``.
127125

128126
#. Create the release branch from the last known good revision from before the
@@ -145,10 +143,12 @@ Tag release candidates:
145143
$ git tag -sa llvmorg-X.Y.Z-rcN
146144

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

153153
::
154154

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

220-
The official testers list is in the file ``RELEASE_TESTERS.TXT``, in the ``LLVM``
221-
repository.
220+
The official testers list is in the file `RELEASE_TESTERS.TXT
221+
<https://github.com/llvm/llvm-project/blob/main/llvm/RELEASE_TESTERS.TXT>`_, in
222+
the LLVM repository.
222223

223224
Community Testing
224225
-----------------
@@ -276,7 +277,8 @@ from the Milestone. Debugging can continue, but on trunk.
276277
Backport Requests
277278
-----------------
278279

279-
Instructions for requesting a backport to a stable branch can be found :doc:`here <GitHub>`.
280+
Instructions for requesting a backport to a stable branch can be found
281+
:ref:`here <backporting>`.
280282

281283
Triaging Bug Reports for Releases
282284
---------------------------------
@@ -301,26 +303,19 @@ This section describes how to triage bug reports:
301303
using the /cherry-pick or /branch comments if this has not been done already.
302304

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

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

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

325320
Release Patch Rules
326321
-------------------
@@ -364,9 +359,8 @@ Update Documentation
364359
Review the documentation in the release branch and ensure that it is up
365360
to date. The "Release Notes" must be updated to reflect new features, bug
366361
fixes, new known issues, and changes in the list of supported platforms.
367-
The "Getting Started Guide" should be updated to reflect the new release
368-
version number tag available from Subversion and changes in basic system
369-
requirements.
362+
The :doc:`GettingStarted` page should be updated to reflect the new release
363+
version number tag and changes in basic system requirements.
370364

371365
.. _tag:
372366

@@ -386,7 +380,8 @@ Update the LLVM Website
386380
The website must be updated before the release announcement is sent out. Here
387381
is what to do:
388382

389-
#. Check out the ``www-releases`` module from GitHub.
383+
#. Check out the `www-releases <https://github.com/llvm/www-releases>`_ repo
384+
from GitHub.
390385

391386
#. Create a new sub-directory ``X.Y.Z`` in the releases directory.
392387

0 commit comments

Comments
 (0)