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

Tool Report Markdown - Next Steps #19067

Open
jmchilton opened this issue Oct 28, 2024 · 0 comments
Open

Tool Report Markdown - Next Steps #19067

jmchilton opened this issue Oct 28, 2024 · 0 comments

Comments

@jmchilton
Copy link
Member

#19054 contains the ability for tools to build Markdown reports from their inputs and outputs. I think the PR is useful on its own but there are things that could improve the development of them and the usage of them at runtime.

Development - Dynamic Linting

Planemo cannot lint reports "in general" ahead of time for broken directives and things like that because any random script could be generating the report. That said, the tool test framework could have a directive to assert tool reports are valid - or could just apply that directly for all outputs that are "tool_markdown" (and probably should).

Development - Static Linting

Static linting would be much better than the above thing when it is possible. It would be nice if we introduced a new kind of configfile that was a report template that we could lint - and hopefully assign directly to the output to skip the copy step that would be needed when using a vanilla configfile for this purpose.

Runtime - Reuse in Pages and Workflow Reports

Ultimately introducing a new block that would embed these tools into reports would be ideal. Pages and reports should have a tag like:

In pages:

```galaxy
history_dataset_report_embed(history_dataset_id=foobar)
```

In reports:

```galaxy
history_dataset_report_embed(output=workflow_output_name)
```

My only concern is rewriting header levels if that makes sense - but that could be a second iteration I think and there is code we use in the tool help rendering code that does something like this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant