Skip to content

Commit

Permalink
Add guidance about the 'Update branch' button (#1392)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk committed Sep 18, 2024
1 parent 22bfaed commit da98447
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions getting-started/pull-request-lifecycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,22 @@ 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 <keeping-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.

Committing/rejecting
====================

Expand Down

0 comments on commit da98447

Please sign in to comment.