From 906e540bf33f94e2dd09cbd4234c3012effdf989 Mon Sep 17 00:00:00 2001 From: David Lawrence Date: Wed, 12 Feb 2025 19:22:00 -0500 Subject: [PATCH] Bug 1946820 - Update API docs to reflect new no-qe-verify flag added in bug 1930197 --- docs/en/rst/api/core/v1/github.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/en/rst/api/core/v1/github.rst b/docs/en/rst/api/core/v1/github.rst index baab01132d..b5ccce4c25 100644 --- a/docs/en/rst/api/core/v1/github.rst +++ b/docs/en/rst/api/core/v1/github.rst @@ -106,7 +106,8 @@ This API endpoint is for adding comments to a bug when a push is made to a linke Github repository. The comment will be short and specially formatted using pieces of information from the full JSON sent to Bugzilla by the push event. If the bug does not have the keyword ``leave-open`` set, the bug will be resolved as FIXED. -Also, the ``qe-verify`` flag will be set to `+` for the bug. For some specific +Also, the ``qe-verify`` flag will be set to `+` for the bug unless the +``?no-qe-verify=1`` query parameter is passed in the URL. For some specific repositories, a Firefox status flag may be set to FIXED. **Github Setup Instructions** @@ -115,6 +116,7 @@ repositories, a Firefox status flag may be set to FIXED. * Click on Webhooks from the left side menu. * Click on the Add Webhook button near the top right. * For the payload url, enter ``https://bugzilla.mozilla.org/rest/github/push_comment``. +* Add ``?no-qe-verify=1`` to the URL if you do not want the ``qe-verify`` flag set. * Choose ``application/json`` for the content type. * You will need to enter the signature secret obtained from a BMO admin (DO NOT SHARE). * Make sure Enable SSL is turned on.