Not sure if you are working with a workflow, a tool, or a service? Check out our introduction on the main differences between them.

Tips and tricks

  • This form of registration is only available to workflows, tools, services, and notebooks that are hosted on GitHub

  • Make sure your file is saved as .dockstore.yml, not dockstore.yml or .dockstore.yaml

  • Put the .dockstore.yml file in the top of your repo or inside .github/

  • If you have multiple workflows/tools/services/notebooks in a single GitHub repository, each one needs a unique name, and it’s a good idea (but not strictly required) to give each one a unique readMePath too.

  • The first line of a .dockstore.yml file references the version of .dockstore.yml syntax being used, not the version/tag of the workflow/tool/service/notebook it describes

  • You can use a single .dockstore.yml file to register multiple tools, workflows, services, and notebooks, provided they are all in the same repo as the .dockstore.yml file

  • A workflow registered with via a .dockstore.yml file is not fundamentally different than a workflow registered in another method, other than the fact that the .dockstore.yml version will be kept up-to-date automatically – but a .dockstore.yml registered tool is different from tools registered in other methods (see this table for more information)

Examples of the filters field

  • The filters: field allows for limiting which GitHub tags and branches appear on a Dockstore entry. Regex can be used here.

  • You can use this regex pattern to include all tags but no branches:

        - /.*/
  • You can use this regex pattern to include tags that only start with localaligner and the branches named develop and master:

        - develop
        - master
        - /localaligner\/.*/