Skip to content

Docs: Clarify GitHub Actions re-run permissions for contributors#1842

Open
pranavchoudhary-tech wants to merge 3 commits into
python:mainfrom
pranavchoudhary-tech:clarify-rerun-jobs
Open

Docs: Clarify GitHub Actions re-run permissions for contributors#1842
pranavchoudhary-tech wants to merge 3 commits into
python:mainfrom
pranavchoudhary-tech:clarify-rerun-jobs

Conversation

@pranavchoudhary-tech

Copy link
Copy Markdown
Contributor

Fixes #1786.

The Developer Guide previously implied that any contributor could click the "Re-run jobs" button to retry a failing CI check. This updates the pull-request-lifecycle.rst documentation to explicitly state that the button is only visible to core developers and triagers. It also provides alternative workarounds for regular contributors (e.g. asking a reviewer, pushing an empty commit, or closing/re-opening the PR).

@read-the-docs-community

read-the-docs-community Bot commented Jun 19, 2026

Copy link
Copy Markdown

Documentation build overview

📚 CPython devguide | 🛠️ Build #33221870 | 📁 Comparing f028dfb against latest (97a689e)

  🔍 Preview build  

2 files changed
± versions/index.html
± getting-started/pull-request-lifecycle/index.html

Comment thread getting-started/pull-request-lifecycle.rst Outdated
Comment thread getting-started/pull-request-lifecycle.rst Outdated
Comment thread getting-started/pull-request-lifecycle.rst Outdated
Comment on lines +704 to +716
to re-run that particular failed check.

The :guilabel:`Re-run jobs` button on GitHub Actions is only visible
to Python core and triage teams. If you have these permissions, go to
the red GitHub Action job, click on the :guilabel:`Re-run jobs` button on the
top right, and select :guilabel:`Re-run failed jobs`. The button will only be
present when all other jobs finished running.

If you are a regular contributor and cannot see the button, you can ask a
reviewer to re-run the failed jobs for you in a PR comment. Alternatively, you
can re-trigger the CI by pushing an empty commit to your branch (for example,
``git commit --allow-empty -m "Trigger CI"``), or by closing and re-opening
your pull request.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
to re-run that particular failed check.
The :guilabel:`Re-run jobs` button on GitHub Actions is only visible
to Python core and triage teams. If you have these permissions, go to
the red GitHub Action job, click on the :guilabel:`Re-run jobs` button on the
top right, and select :guilabel:`Re-run failed jobs`. The button will only be
present when all other jobs finished running.
If you are a regular contributor and cannot see the button, you can ask a
reviewer to re-run the failed jobs for you in a PR comment. Alternatively, you
can re-trigger the CI by pushing an empty commit to your branch (for example,
``git commit --allow-empty -m "Trigger CI"``), or by closing and re-opening
your pull request.
to re-run that particular failed check. Note that the :guilabel:`Re-run jobs`
button is only visible to members of the core and triage team. If you have those
permissions, go to the failed GitHub Action job, click :guilabel:`Re-run jobs` on
the top right, and select :guilabel:`Re-run failed jobs`. The button is only
present once all other jobs have finished.
If don't have access to the button, ask a member of the teams to
re-run the jobs for you. Alternatively, you can re-trigger CI yourself by
pushing an empty commit, or by updating your branch with the
:guilabel:`Update branch` button.

I think we can simplify this a little.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify how to re-run GitHub actions on PRs

3 participants