You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#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:
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.
The text was updated successfully, but these errors were encountered:
#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:
In reports:
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.
The text was updated successfully, but these errors were encountered: