Skip to content

docs: clarify behavior of label and commit requirement#4846

Merged
cobaltt7 merged 9 commits into
psf:mainfrom
amritamishra01:docs/clarify-ci-build-all-wheels
Nov 23, 2025
Merged

docs: clarify behavior of label and commit requirement#4846
cobaltt7 merged 9 commits into
psf:mainfrom
amritamishra01:docs/clarify-ci-build-all-wheels

Conversation

@amritamishra01
Copy link
Copy Markdown
Contributor

@amritamishra01 amritamishra01 commented Nov 18, 2025

This PR adds documentation explaining the behavior of the ci: build all wheels label.

Why this change is needed

The label exists to trigger a full wheel build on a PR, but GitHub Actions does not automatically rerun CI when a label is added.
This leads to confusion because contributors expect the wheel build to start immediately, but it only works after pushing a new commit.

What this PR adds

  • A new section in CONTRIBUTING.md describing:
    • the purpose of the ci: build all wheels label,
    • the requirement to push a commit after applying the label,
    • how to trigger the workflow using an empty commit,
    • why GitHub Actions is not configured to run wheel builds directly on label events (security/resource reasons).

Security and design considerations

This PR intentionally avoids modifying CI triggers because building wheels on label-added events can introduce security issues (e.g., running untrusted fork code with elevated permissions) and heavy CI load.
Adding documentation is the safest and maintainer-aligned solution.

References

Comment thread CONTRIBUTING.md Outdated
@cobaltt7 cobaltt7 added the ci: skip news Pull requests that don't need a changelog entry. label Nov 18, 2025
Comment thread CONTRIBUTING.md
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

IF this is to be documented (which a maintainer has not commented on the linked issue yet) it should live with the rest of issue triage, as the label can only be added by users with triage or greater permissions.

See https://black.readthedocs.io/en/stable/contributing/issue_triage.html

Furthermore, (and the reason it was positioned as whether it may be worth removing), this means both the maintainer has to add the label and then something needs to trigger the commit to check the IF statement.

It definitely is a maintainer decision on whether or not to document it.

@amritamishra01
Copy link
Copy Markdown
Contributor Author

Hi! I’ve updated the PR with the corrected CI-related label documentation and removed the accidental code block formatting. The duplicate PR has also been closed.

Please let me know if any further adjustments are needed. Thank you!

@cobaltt7
Copy link
Copy Markdown
Collaborator

Please read my previous comments, as well as revert the previous change in CONTRIBUTING.md

@amritamishra01
Copy link
Copy Markdown
Contributor Author

Hi! @cobaltt7 I’ve finalized the CI label documentation as requested, cleaned up the formatting, and resolved the merge conflicts.
Please let me know if any further changes are needed. Thank you!

@cobaltt7 cobaltt7 self-requested a review November 23, 2025 13:57
@cobaltt7 cobaltt7 merged commit aa143e7 into psf:main Nov 23, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci: skip news Pull requests that don't need a changelog entry.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Internal: Documentation/state of ci: build all wheels label

3 participants