Skip to content

Commit da98447

Browse files
authored
Add guidance about the 'Update branch' button (#1392)
1 parent 22bfaed commit da98447

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

getting-started/pull-request-lifecycle.rst

+16
Original file line numberDiff line numberDiff line change
@@ -542,6 +542,22 @@ If you identify such flaky behavior, look for an issue in the `issue tracker`_
542542
that describes this particular flakiness. Create a new issue if you can't
543543
find one.
544544

545+
:guilabel:`Update branch` button
546+
================================
547+
548+
You can click on the :guilabel:`Update branch` button to merge the latest
549+
changes from the base branch (usually ``main``) into the PR.
550+
This is useful to :ref:`keep the CI green <keeping-ci-green>` for old PRs,
551+
or to check if a CI failure has been fixed in the base branch.
552+
553+
If the PR is very old, it may be useful to update the branch before merging to
554+
ensure that the PR does not fail any CI checks that were added or changed since
555+
CI last ran.
556+
557+
Do not click :guilabel:`Update branch` without a good reason because it notifies
558+
everyone watching the PR that there are new changes, when there are not,
559+
and it uses up limited CI resources.
560+
545561
Committing/rejecting
546562
====================
547563

0 commit comments

Comments
 (0)