Skip to content

Add section on keeping CI green #1215

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

Merged
ambv merged 3 commits into from
Feb 6, 2024
Merged

Add section on keeping CI green #1215

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4521da
Add section on keeping CI green
ambv Nov 3, 2023
35aa198
Run pre-commit
ambv Nov 3, 2023
a738be9
Apply suggestions from code review
ambv Feb 6, 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
Prev Previous commit
Apply suggestions from code review 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
  • Loading branch information
@ambv @hugovk
@JelleZijlstra @ezio-melotti
4 people authored Feb 6, 2024
commit a738be9e84add7ead42341b8ebb543df3c2ed33a
10 changes: 5 additions & 5 deletions getting-started/pull-request-lifecycle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,11 +500,11 @@ the PR, and their review should not be dismissed.

.. _keeping-ci-green:

Keeping Continuous Integration green
Keeping continuous integration green
====================================

Our change management workflows generally won't allow merging PRs with
failures on them. Therefore, if you see a CI failure on a PR, have a look
failures. Therefore, if you see a CI failure on a PR, have a look
what it is about.

Usually the failure will be directly related to the changes in the current
Expand All @@ -516,17 +516,17 @@ comment will be helpful to the PR author.
If the failure doesn't look related to the change you're looking at, check
if it's not present on the `Release Status`_ Buildbot dashboard as well.
If so, that means the failure was introduced in a prior change. Using Buildbot's
UI you can find which PR introduced the issue and comment there that it
UI you can find which PR introduced the issue and comment that it
affects other PRs.

If you still don't see where the failure originates from, check for
an "This branch is out-of-date with the base branch" sign next to the
a "This branch is out-of-date with the base branch" sign next to the
list of executed checks. Clicking "Update branch" next to this message
will merge in the latest changes from the base branch into the PR.

If this still doesn't help with the failure on the PR, you can try
to re-run that particular failed check. Go to the red GitHub Action job,
and find a button on the top right called "Re-run jobs". Select
click on the "Re-run jobs" button on the top right, and select
"Re-run failed jobs". The button will only be present when all other jobs
finished running.
Comment on lines +527 to +531
Copy link
Copy Markdown
Member

@hugovk hugovk Nov 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only applies to core devs and triagers?

Copy link
Copy Markdown
Member

@JelleZijlstra JelleZijlstra Nov 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's also true for the previous paragraph (about merging in main).

Copy link
Copy Markdown
Member

@hugovk hugovk Nov 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any contributor can merge main into their PR, for example: python/cpython#105984 (commits)


Expand Down