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

Publishing is broken for edx-drf-extensions #319

Closed
3 of 4 tasks
timmc-edx opened this issue Apr 6, 2023 · 3 comments
Closed
3 of 4 tasks

Publishing is broken for edx-drf-extensions #319

timmc-edx opened this issue Apr 6, 2023 · 3 comments
Assignees

Comments

@timmc-edx
Copy link
Contributor

timmc-edx commented Apr 6, 2023

When I tried to release a new version, the PyPI uploader failed:

Warning:  You are using "pypa/gh-action-pypi-publish@master". The "master" branch of this project has been sunset and will not receive any updates, not even security bug fixes. Please, make sure to use a supported version. If you want to pin to v1 major version, use "pypa/gh-action-pypi-publish@release/v1". If you feel adventurous, you may opt to use use "pypa/gh-action-pypi-publish@unstable/v1" instead. A more general recommendation is to pin to exact tags or commit shas.
Checking dist/edx_drf_extensions-8.5.0-py2.py3-none-any.whl: FAILED
ERROR    `long_description` has syntax errors in markup and would not be        
         rendered on PyPI.                                                      
         No content rendered from RST source.                                   
WARNING  `long_description_content_type` missing. defaulting to `text/x-rst`.   
Checking dist/edx-drf-extensions-8.5.0.tar.gz: PASSED with warnings
WARNING  `long_description_content_type` missing. defaulting to `text/x-rst`.   
WARNING  `long_description` missing.                                            

Nothing relevant seems to have changed since the previous release, though.

A/C:

  • Fix releases
    • We believe we just need a long description for this package.
    • Ensure that this that is using a standarized GitHub action.
  • Update changelog with new release, and a note that 8.5.0 failed to release (along with some other tags I created while trying to debug this)
@timmc-edx
Copy link
Contributor Author

I'm not sure if this will help, but we should probably be on the supported branch for the publishing action: #318

@timmc-edx
Copy link
Contributor Author

That didn't help, nor did using a different tag format. (I had used v8.5.0 instead of 8.5.0, and had not used an annotated tag, so I wanted to rule out those deviations from the instructions before investigating nondeterminism in the GHA.) But it looks like this is a bug in Twine, and we may be able to work around it by adding a long_description to the package: pypa/twine#908

I had read the error as "you have bad syntax, so I'm discarding the description", but it seems like it might actually be "the description is missing, so I'm calling it bad syntax"!

@robrap robrap self-assigned this Apr 11, 2023
robrap added a commit that referenced this issue Apr 11, 2023
Setup needed a ``long_description`` to all packaging to
work, potentially due to a twine bug. This should fix
the issue.

See #319
@robrap robrap mentioned this issue Apr 11, 2023
10 tasks
robrap added a commit that referenced this issue Apr 11, 2023
Setup needed a ``long_description`` to all packaging to
work, potentially due to a twine bug. This should fix
the issue.

See #319
@robrap
Copy link
Contributor

robrap commented Apr 11, 2023

@timmc-edx: I'm not clear on what "Ensure that this that is using a standarized GitHub action." means in the AC above. What is needed, or can that be removed and can this be closed? Thanks.

@robrap robrap closed this as completed Apr 11, 2023
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

No branches or pull requests

2 participants