Templates
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
Make sure your file is saved as
.dockstore.yml
, notdockstore.yml
or.dockstore.yaml
Put the .dockstore.yml file in the top of your repo or inside
.github/
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 it describes
You can use a single .dockstore.yml file to register multiple tools and workflows, 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 branches and tags appear on a Dockstore entry. Regex can be used here.You can use this regex pattern to include all tags but no branches:
filters:
tags:
- /.*/
You can use this regex pattern to include tags that only start with
localaligner
and the branches nameddevelop
andmaster
:
filters:
branches:
- develop
- master
tags:
- /localaligner\/.*/