core-workflow
core-workflow copied to clipboard
python
`skip-news` and `type-tests` badges
The short story
It would be nice if skip-news label is automatically added when both conditions are true:
- PR has
type-testsbadge - It does not have new
NEWSentry
Example: https://github.com/python/cpython/pull/30472
Long version
I love working on unit-tests in CPython, but I have a small problem. When I submit a PR the CI is usually red, because NEWS check fails: there's no NEWS entry.
Most of the reviewers say that test-only changes should not go to NEWS (and I agree). But, right now the only way for non-members is to wait for someone who will put skip-news badge manually to turn the CI to be green. I don't think that precious time should be spent on that! 🙂
Otherwise, it is less-likely to get a review (because PR has this red cross as its status, some people might think that something is broken). For new contributors this might be even more problematic.
@sobolevn off-topic, Are you interested in becoming a Triage member? If so, please mail me :) (see my Github profile) I have the bandwidth to mentor you as a triage member :)
In my experience, skip-news label should also be added to type-documentation PRs as generally docs PRs don't require a news fragment.
Please see https://github.com/python/core-workflow/issues/363 for the previous discussion in this matter.
IMHO the opt-out model we currently have works well enough and makes the check more predictable. We could add custom rules for docs or tests, but they would have to be documented and there are cases where a NEWS entry is still required.
skip news is now automatically applied to all PRs that only have a docs label and don't already have a news item attached.
We could also implement this for the tests label. Is this something we want to do? If so you can assign me and I'll prepare a PR.
This might come in handy for https://github.com/python/cpython/issues/94808