Ensuring Workflows meet Best Practices

Authors: orcid logoHelena Rasche avatar Helena Rasche orcid logoEli Chadwick avatar Eli Chadwick Add Contributions!

When you are editing a workflow, there are a number of additional steps you can take to ensure that it is a Best Practice workflow and will be more reusable.

  1. Open a workflow for editing
  2. In the workflow menu bar, you’ll find the Workflow Options dropdown menu.

  3. Click on it and select Best Practices from the dropdown menu.

    screenshot showing the best practices menu item in the gear dropdown.

  4. This will take you to a new side panel, which allows you to investigate and correct any issues with your workflow.

    screenshot showing the best practices side panel. several issues are raised like a missing annotation with a link to add that, and non-optional inputs that are unconnected. Additionally several items already have green checks like the workflow defining creator information and a license.

The Galaxy community also has a guide on best practices for maintaining workflows. This guide includes the best practices from the Galaxy workflow panel, plus:

  • adding tests to the workflow
  • publishing the workflow on GitHub, a public GitLab server, or another public version-controlled repository
  • registering the workflow with a workflow registry such as WorkflowHub or Dockstore
Persistent URL
Resource PURL: https://gxy.io/GTN:F00397
Still have questions?
Gitter Chat Support
Galaxy Help Forum