Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add guidance about the 'Update branch' button #1392

Merged
merged 2 commits into from
Sep 18, 2024
Merged

Add guidance about the 'Update branch' button #1392

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99d8a2c
Add guidance about the 'Update branch' button
hugovk Sep 9, 2024
b401d19
It may be useful to update before merge
hugovk Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions getting-started/pull-request-lifecycle.rst
View file
Open in desktop
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
JelleZijlstra marked this conversation as resolved.
Show resolved Hide resolved
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
Loading