[llvm] Document use of `skip-precommit-approval` label for non-review pull requests (PR #81053)

David Blaikie via llvm-commits llvm-commits at lists.llvm.org
Thu Feb 8 16:38:57 PST 2024


https://github.com/dwblaikie updated https://github.com/llvm/llvm-project/pull/81053

>From a923d34a6e2c2196a5a0ebca13f8bae171c05aaf Mon Sep 17 00:00:00 2001
From: David Blaikie <dblaikie at gmail.com>
Date: Wed, 7 Feb 2024 03:13:37 +0000
Subject: [PATCH 1/2] Document use of `skip-precommit-approval` label for
 non-review pull requests

Derived from this discussion: https://discourse.llvm.org/t/prs-without-approvals-muddy-the-waters/76656
---
 llvm/docs/CodeReview.rst | 6 ++++++
 llvm/docs/GitHub.rst     | 6 ++++++
 2 files changed, 12 insertions(+)

diff --git a/llvm/docs/CodeReview.rst b/llvm/docs/CodeReview.rst
index f1d5b6c9c99206..e1225ee01ac2f8 100644
--- a/llvm/docs/CodeReview.rst
+++ b/llvm/docs/CodeReview.rst
@@ -103,6 +103,12 @@ ready to be committed. Specifically, once a patch is sent out for review, it
 needs an explicit approval before it is committed. Do not assume silent
 approval, or solicit objections to a patch with a deadline.
 
+.. note::
+   If you are using a Pull Request to get precommit CI results, but not
+   because it needs a precommit review, apply the `skip-precommit-approval
+   <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`
+   label to the PR.
+
 Acknowledge All Reviewer Feedback
 ---------------------------------
 
diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index c3fbb64c2dd96a..91d431012c8bfa 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -30,6 +30,12 @@ describes the typical workflow of creating a Pull Request and getting it reviewe
 and accepted. This is meant as an overview of the GitHub workflow, for complete
 documentation refer to `GitHub's documentation <https://docs.github.com/pull-requests>`_.
 
+.. note::
+   If you are using a Pull Request to get precommit CI results, but not
+   because it needs a precommit review, apply the `skip-precommit-approval
+   <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`
+   label to the PR.
+
 GitHub Tools
 ------------
 You can interact with GitHub in several ways: via git command line tools,

>From dc937e4b1ff02a50e92a2f6fddcc36497a872496 Mon Sep 17 00:00:00 2001
From: David Blaikie <dblaikie at gmail.com>
Date: Wed, 7 Feb 2024 03:13:37 +0000
Subject: [PATCH 2/2] Document use of `skip-precommit-approval` label for
 non-review pull requests

Derived from this discussion: https://discourse.llvm.org/t/prs-without-approvals-muddy-the-waters/76656
---
 llvm/docs/CodeReview.rst | 6 +++---
 llvm/docs/GitHub.rst     | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/llvm/docs/CodeReview.rst b/llvm/docs/CodeReview.rst
index e1225ee01ac2f8..e3a74946e5933b 100644
--- a/llvm/docs/CodeReview.rst
+++ b/llvm/docs/CodeReview.rst
@@ -104,9 +104,9 @@ needs an explicit approval before it is committed. Do not assume silent
 approval, or solicit objections to a patch with a deadline.
 
 .. note::
-   If you are using a Pull Request to get precommit CI results, but not
-   because it needs a precommit review, apply the `skip-precommit-approval
-   <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`
+   If you are using a Pull Request for purposes other than review
+   (eg: precommit CI results, convenient web-based reverts, etc)
+   `skip-precommit-approval<https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`
    label to the PR.
 
 Acknowledge All Reviewer Feedback
diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index 91d431012c8bfa..51a7310a8a72d5 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -31,9 +31,9 @@ and accepted. This is meant as an overview of the GitHub workflow, for complete
 documentation refer to `GitHub's documentation <https://docs.github.com/pull-requests>`_.
 
 .. note::
-   If you are using a Pull Request to get precommit CI results, but not
-   because it needs a precommit review, apply the `skip-precommit-approval
-   <https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`
+   If you are using a Pull Request for purposes other than review
+   (eg: precommit CI results, convenient web-based reverts, etc)
+   `skip-precommit-approval<https://github.com/llvm/llvm-project/labels?q=skip-precommit-approval>`
    label to the PR.
 
 GitHub Tools



More information about the llvm-commits mailing list