Skip to content

Give maintainers the ability to provide reason for yanking #7856

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

Closed
di opened this issue Apr 27, 2020 · 3 comments · Fixed by #7916
Closed

Give maintainers the ability to provide reason for yanking #7856

di opened this issue Apr 27, 2020 · 3 comments · Fixed by #7916
Labels
feature request good first issue This issue is ideal for first-time contributors! UX/UI design, user experience, user interface

Comments

@di
Copy link
Member

di commented Apr 27, 2020

PEP 592 permits the use of an arbitrary string which gives a reason for yanking:

The value of the data-yanked attribute, if present, is an arbitrary string that represents the reason for why the file has been yanked. Tools that process the simple repository API MAY surface this string to end users.

PyPI does not currently support this. Completing this issue would include a UI to allow the user to set this when yanking, an update to the DB model to change this from a boolean to a text field, and an update to the simple page to surface this value if present.


Good First Issue: This issue is good for first time contributors. If you've already contributed to Warehouse, work on another issue without this label instead. If there is not a corresponding pull request for this issue, it is up for grabs. For directions for getting set up, see our Getting Started Guide. If you are working on this issue and have questions, feel free to ask them here, #pypa-dev on Freenode, or the pypa-dev mailing list.

@di di added good first issue This issue is ideal for first-time contributors! feature request labels Apr 27, 2020
@nlhkabu nlhkabu added the UX/UI design, user experience, user interface label Apr 27, 2020
@pradyunsg
Copy link
Contributor

FYI: pip prints the reason for yanking if it is provided, and if it is not, it prints "Reason for being yanked: <none given>".

As a result of this, any yanked releases on PyPI today will result in pip's output when installing a yanked release saying "Reason for being yanked: <none given>".

Reported/mentioned in pypa/pip#8160 (comment).

@deveshks
Copy link
Contributor

deveshks commented May 9, 2020

Just to confirm, is this issue also taken up by someone to work on as per #7886 (comment) ?

@daneah
Copy link
Contributor

daneah commented May 9, 2020

@deveshks yep, I'm working on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request good first issue This issue is ideal for first-time contributors! UX/UI design, user experience, user interface
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants