Skip to content

Commit 7dbb366

Browse files
committed
HowToReleaseLLVM: Add description of the bug triage process
Reviewed By: andreil99 Differential Revision: https://reviews.llvm.org/D126985
1 parent 4dcb42f commit 7dbb366

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

llvm/docs/HowToReleaseLLVM.rst

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,55 @@ Backport Requests
262262

263263
Instructions for requesting a backport to a stable branch can be found :doc:`here <GitHub>`.
264264

265+
Triaging Bug Reports for Releases
266+
---------------------------------
267+
268+
This section describes how to triage bug reports:
269+
270+
#. Search for bugs with a Release Milestone that have not been added to the
271+
"Release Status" github project:
272+
273+
https://github.com/llvm/llvm-project/issues?q=is%3Aissue+milestone%3A%22LLVM+14.0.5+Release%22+no%3Aproject+
274+
275+
Replace 14.0.5 in this query with the version from the Release Milestone being
276+
targeted.
277+
278+
Add these bugs to the "Release Status" project.
279+
280+
#. Navigate to the `Release Status project <https://github.com/orgs/llvm/projects/3>`_
281+
to see the list of bugs that are being considered for the release.
282+
283+
#. Review each bug and first check if it has been fixed in main. If it has, update
284+
its status to "Needs Pull Request", and create a pull request for the fix
285+
using the /cherry-pick or /branch comments if this has not been done already.
286+
287+
#. If a bug has been fixed and has a pull request created for backporting it,
288+
then update its status to "Needs Review" and notify a knowledgeable reviewer.
289+
Usually you will want to notify the person who approved the patch in Phabricator,
290+
but you may use your best judgement on who a good reviewer would be. Once
291+
you have identified the reviewer(s), assign the issue to them and mention
292+
them (i.e @username) in a comment and ask them if the patch is safe to backport.
293+
You should also review the bug yourself to ensure that it meets the requirements
294+
for committing to the release branch.
295+
296+
#. Once a bug has been reviewed, add the release:reviewed label and update the
297+
issue's status to "Needs Merge". Check the pull request associated with the
298+
issue. If all the tests pass, then the pull request can be merged. If not,
299+
then add a comment on the issue asking someone to take a look at the failures.
300+
301+
#. Once the pull request has been merged push it to the official release branch:
302+
303+
::
304+
305+
git checkout release/XX.x
306+
git pull --ff-only https://github.com/llvm/llvm-project-release-prs release/XX.x
307+
git push https://github.com/llvm/llvm-project release/XX.x:release/XX.x
308+
309+
Then add a comment to the issue stating that the fix has been merged along with
310+
the git hashes from the release branch. Add the release:merged label to the issue
311+
and close it.
312+
313+
265314
Release Patch Rules
266315
-------------------
267316

0 commit comments

Comments
 (0)