From 99d8a2cdbb302ce7caaa76a200d65dd20ece4358 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Mon, 9 Sep 2024 18:31:16 +0300 Subject: [PATCH 1/2] Add guidance about the 'Update branch' button --- getting-started/pull-request-lifecycle.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/getting-started/pull-request-lifecycle.rst b/getting-started/pull-request-lifecycle.rst index 42b3412816..97b91560ef 100644 --- a/getting-started/pull-request-lifecycle.rst +++ b/getting-started/pull-request-lifecycle.rst @@ -542,6 +542,18 @@ If you identify such flaky behavior, look for an issue in the `issue tracker`_ that describes this particular flakiness. Create a new issue if you can't find one. +:guilabel:`Update branch` button +================================ + +You can click on the :guilabel:`Update branch` button to merge the latest +changes from the base branch (usually ``main``) into the PR. +This is useful to :ref:`keep the CI green ` for old PRs, +or to check if a CI failure has been fixed in the base branch. + +Do not click :guilabel:`Update branch` without a good reason because it notifies +everyone watching the PR that there are new changes, when there are not, +and it uses up limited CI resources. + Committing/rejecting ==================== From b401d19092c8d25ed24d4bb2af9fea21eea1febf Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Wed, 11 Sep 2024 21:41:06 +0300 Subject: [PATCH 2/2] It may be useful to update before merge --- getting-started/pull-request-lifecycle.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/getting-started/pull-request-lifecycle.rst b/getting-started/pull-request-lifecycle.rst index 97b91560ef..e91ba7249b 100644 --- a/getting-started/pull-request-lifecycle.rst +++ b/getting-started/pull-request-lifecycle.rst @@ -550,6 +550,10 @@ changes from the base branch (usually ``main``) into the PR. This is useful to :ref:`keep the CI green ` for old PRs, or to check if a CI failure has been fixed in the base branch. +If the PR is very old, it may be useful to update the branch before merging to +ensure that the PR does not fail any CI checks that were added or changed since +CI last ran. + Do not click :guilabel:`Update branch` without a good reason because it notifies everyone watching the PR that there are new changes, when there are not, and it uses up limited CI resources.