Change info message for markdown readme in repo#1398
Change info message for markdown readme in repo#1398mvdbeek merged 3 commits intogalaxyproject:masterfrom
Conversation
|
@mvdbeek To answer your question from Matrix, a README.rst is rendered on the TS 1.0 (see e.g. https://toolshed.g2.bx.psu.edu/repository?repository_id=552adf1ac7cd330f&changeset_revision=18c0086450bb ), while a README.md is not (see e.g. https://toolshed.g2.bx.psu.edu/repository?repository_id=9be0eab5a3639fee&changeset_revision=74810db257cc ). So maybe we should keep this check for now? |
|
What I mean is, this isn't displayed at all in the install process in Galaxy, so you wouldn't ordinarily find it. |
|
(and having a markdown readme is anyway a bit irrelevant as a check, you should be free to have one whether or not you also have a RST file) |
|
I think a tool developer may find the |
|
What about: diff --git a/planemo/shed_lint.py b/planemo/shed_lint.py
index 38f4ffd4..322d1675 100644
--- a/planemo/shed_lint.py
+++ b/planemo/shed_lint.py
@@ -159,16 +159,15 @@ def lint_readme(realized_repository, lint_ctx):
if os.path.exists(readme):
readme_found = readme
- readme_md = os.path.join(path, "README.md")
- if not readme_found and os.path.exists(readme_md):
- lint_ctx.warn("Tool Shed doesn't render markdown, " "README.md is invalid readme.")
- return
-
if not readme_found:
# TODO: filter on TYPE and make this a warning if
# unrestricted repository - need to update iuc standards
# first though.
- lint_ctx.info("No README found skipping.")
+ readme_md = os.path.join(path, "README.md")
+ if os.path.exists(readme_md):
+ lint_ctx.info("Found README in Markdown format, which is not rendered by the Tool Shed, skipping")
+ else:
+ lint_ctx.info("No README found, skipping.")
return
if readme_found.endswith(".rst"): |
Co-authored-by: Nicola Soranzo <nicola.soranzo@earlham.ac.uk>
not sure if we should check for correct markdown.