From aa73df76ab09476ae5f90e0c9fbe325caa3b240c Mon Sep 17 00:00:00 2001 From: Matthias Bernt Date: Tue, 24 Oct 2023 08:53:32 +0200 Subject: [PATCH 1/3] drop markdown check for md --- planemo/shed_lint.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/planemo/shed_lint.py b/planemo/shed_lint.py index 38f4ffd4a..4d522ad5e 100644 --- a/planemo/shed_lint.py +++ b/planemo/shed_lint.py @@ -159,11 +159,6 @@ 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 From 81a40d8909da90b7efdb7495a2b62928c3e4debb Mon Sep 17 00:00:00 2001 From: Matthias Bernt Date: Tue, 24 Oct 2023 10:50:46 +0200 Subject: [PATCH 2/3] also allow md in test --- tests/test_shed_lint.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_shed_lint.py b/tests/test_shed_lint.py index 899d8b46a..f476daaf4 100644 --- a/tests/test_shed_lint.py +++ b/tests/test_shed_lint.py @@ -21,7 +21,7 @@ def test_invalid_repos(self): with self._isolate_repo("bad_readme_rst"): self._check_exit_code(["shed_lint"], exit_code=1) with self._isolate_repo("bad_readme_md"): - self._check_exit_code(["shed_lint"], exit_code=1) + self._check_exit_code(["shed_lint"], exit_code=0) with self._isolate_repo("bad_repo_name"): self._check_exit_code(["shed_lint"], exit_code=1) with self._isolate_repo("bad_missing_include"): From 14671db82d8233b6917cd37207570700189d3b84 Mon Sep 17 00:00:00 2001 From: Matthias Bernt Date: Thu, 26 Oct 2023 13:19:52 +0200 Subject: [PATCH 3/3] info about md readme Co-authored-by: Nicola Soranzo --- planemo/shed_lint.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/planemo/shed_lint.py b/planemo/shed_lint.py index 4d522ad5e..322d16756 100644 --- a/planemo/shed_lint.py +++ b/planemo/shed_lint.py @@ -163,7 +163,11 @@ def lint_readme(realized_repository, lint_ctx): # 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"):