Remove unnecessary usage of readme_renderer.markdown #421
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #421 +/- ##
==========================================
- Coverage 78.29% 78.23% -0.06%
==========================================
Files 14 14
Lines 737 735 -2
Branches 106 106
==========================================
- Hits 577 575 -2
- Misses 127 128 +1
+ Partials 33 32 -1
Continue to review full report at Codecov.
|
Does that mean that the check does not really do anything in case of markdown? |
|
That's correct. Cmark does not error when it's given malformed markup, it will mostly just pass it through, being careful to close any dangling html tag if necessary. |
|
Temporary work around is to |
3 tasks
g-chauvel
pushed a commit
to g-chauvel/zuul-jobs
that referenced
this pull request
Oct 7, 2020
This dependency was added with Iaf4da5aedaa3814b2ecebed4391da2324d3e388d to prevent a warning when using "twine check" with text/markdown descriptions. Per [1], this check doesn't really do anything and will never fail. We are now having issues using this role with with Python 3.8 on the executor as the md dependency pulls in cmarkgfm which has binary dependencies but does not publish any wheels; meaning the executor fails to install as it does not have a toolchain setup. Unfortunately upstream is not particularly active, so building good manylinux wheels is not something we're going to be able to deal with in a timely fashion. Given that this is not a failure, and isn't really doing anything and blocks Python 3.8, it seems our best course is to remove this dependency. [1] pypa/twine#421 Change-Id: Iac5c9f63d41375889e4fdad67b9a45a24a644341
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #420.
Rendering plaintext or markdown will never fail, so we'll just automatically pass the check if those content types have been specified.