Skip to content

Include workflow and script version in execution report #3917

@joanmarticarreras

Description

@joanmarticarreras

New feature

Hi! As talked with @ewels over nextflow.slack.com, the current template for the file report.html does not include information on which pipeline or workflow version was used to produce the data.

The report itself offers, dates, nextflow version and depending on how the Docker images are labelled, also their version control, however not the current pipeline version. From a QA perspective, especially regarding in-house development, it would be better to add the pipeline version or workflow itself there.

Usage scenario

General scenario. In terms of QA and tracablity, NF version, pipeline version and Docker image versions should appear on report.html.

Suggest implementation

On modules/nextflow/src/main/resources/nextflow/trace/ReportTemplate.html, add workflow.manifest.version between workflow.scriptName and workflow.scriptId.

<% if (workflow.scriptName) { %>
          <dt class="col-sm-3">Script name</dt>
          <dd class="col-sm-9"><samp>${workflow.scriptName}</samp></dd>
        <% } %>

<% if (workflow.manifest.version) { %>
          <dt class="col-sm-3">Script version</dt>
          <dd class="col-sm-9"><samp>${workflow.manifest.version}</samp></dd>
        <% } %>

        <% if (workflow.scriptId) { %>
          <dt class="col-sm-3">Script ID</dt>
          <dd class="col-sm-9"><code>${workflow.scriptId}</code></dd>
        <% } %>

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions