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.

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

Update documentation that news entries cannot be empty files #9657

Closed
QuentinLee5 opened this issue Feb 25, 2021 · 10 comments
Closed

Update documentation that news entries cannot be empty files #9657

QuentinLee5 opened this issue Feb 25, 2021 · 10 comments
Labels
S: needs triage Issues/PRs that need to be triaged

Comments

@QuentinLee5
Copy link
Contributor

Currently, the documentation regarding news entries for trivial PRs mentions that contributors can create an empty news entry using for example the following command on Linux touch news/$(uuidgen).trivial.rst.

The check for a news entry in PRs however does not longer allow empty .trivial files.

https://github.com/pypa/pip/blob/master/docs/html/development/contributing.rst needs to be updated according to this.

@pfmoore
Copy link
Member

pfmoore commented Feb 25, 2021

I'd actually say that the correct fix is to allow empty .trivial files again. I recall there was a discussion about this somewhere, and maybe there's a reason we aren't going to do that, but can a link to the reason be added here, if that's the case?

@pradyunsg
Copy link
Member

Well, this is a good stopgap solution until we fix the issue on the bot. 🤷🏻‍♂️

@pfmoore
Copy link
Member

pfmoore commented Feb 25, 2021

I'm fine with that. I just wasn't sure if it was a temporary thing.

@pradyunsg
Copy link
Member

I'm definitely viewing this as temporary, but it also won't hurt to just have people follow this long term. :)

@QuentinLee5
Copy link
Contributor Author

So we should change the documentation that contributors should add a news entry at news/$(uuidgen).trivial.rst with a small description explaining what the PR changes (or would a non-empty news entry be sufficient)?

@pfmoore
Copy link
Member

pfmoore commented Feb 25, 2021

Let's be explicit here, and just say that a .trivial must contain something, but that's due to a bug in the validation, and the information in there is ignored, so a blank space is sufficient.

@ichard26
Copy link
Member

ichard26 commented Feb 26, 2021

Well, this is a good stopgap solution until we fix the issue on the bot. 🤷🏻‍♂️

ref: pypa/browntruck#24

@wanghaojiang1
Copy link

This issue seems like a good first issue for beginning contributers. I would like to work on this issue.

@pradyunsg pradyunsg added the S: needs triage Issues/PRs that need to be triaged label Mar 6, 2021
@ichard26
Copy link
Member

It appears that the new changelog GitHub App check handles empty files just fine: https://github.com/pypa/pip/pull/12534/files#diff-8a3182a318bebebaebb86d2efe42c6594eb98182b87d1a99e66a34b61705ed33.

@uranusjr
Copy link
Member

Yes, this has been fixed a while ago. Thanks for finding this!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
S: needs triage Issues/PRs that need to be triaged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants