openstack
/
dib-utils
Code Issues Proposed changes

Force to use markdown to prevent pypi issue 

Recently the pypi team have reintroduce some deactivated tests
on package deployment and especially tests concerning long_description
syntaxe.

If projects don't specify that they use the markdown format the
package deployment will fail if something went wrong in the markdown format.

By example if a project use inline literal this can be an issue due to
the fact that if `long_description_content_type` is missing [1]. The
default format will be `text/x-rst` where code block is different from
markdown.

These changes force to use the markdown format to avoid this kind of issue
on project who use `README` at markdown format.

[1] http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007459.html

For more details:
https://github.com/pypa/warehouse/issues/5890#issuecomment-494868157

Change-Id: I20141a86ba17bb02d5078f9692a286009c0df5db
This commit is contained in:
Hervé Beraud 2019-07-01 20:43:45 +02:00
parent 67c604f83a
commit f3ae8486d7
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
setup.cfg
View File

@ -2,6 +2,7 @@
name = dib-utils
summary = Pieces of diskimage-builder that are useful without the rest of the project
description-file =
long_description_content_type = text/markdown
README.md
author = HP Cloud Services
author_email = openstack-dev@lists.openstack.org