There are units for publishing reports about workflow runs. In other words, one can insert a properly configured veles.publishing.publisher.Publisher unit before veles.plumbing.EndPoint to write HTML or PDF or online wiki page with very detailed information what input data and the configuration were specified, how the workflow ran, what metric values were achieved and what plots were drawn. Confluence, Markdown and PDF publishing backend are supported.
If you are using veles.znicz.standard_workflow.StandardWorkflow, using Publisher is as simple as calling:
self.link_publisher(<parent>)
inside veles.znicz.standard_workflow.StandardWorkflow.create_workflow(). It will require some basic configuration which is backend-specific, for example, this is for Confluence:
"publisher": {
"backends": {
"confluence": {
"server": "http://localhost:8000",
"username": "user", "password": "password",
"space": "VEL", "parent": "Veles"
}
}
}
A typical report consists of several sections.
Publisher can be extended with more report data by overriding veles.publishing.publisher.Publisher.gather_info() method and adding the corresponding support to the used backends.