Skip to content

Commit 4ca2512

Browse files
committed
Add warning for name restrictions in builds section
This is documented internally with [workflow config schema][1] and [various wildcard constraints][2]. [1]: https://github.com/nextstrain/ncov/blob/464041debc66a86a33d3c1c697026a1adeb1d326/workflow/schemas/config.schema.yaml [2]: https://github.com/nextstrain/ncov/blob/464041debc66a86a33d3c1c697026a1adeb1d326/Snakefile#L132-L138
1 parent 2ef49f2 commit 4ca2512

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/src/reference/configuration.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,11 @@ builds
6161

6262
- type: object
6363
- description: Named builds to produce by the workflow from the given inputs. Builds are indexed by name and include any number of build attributes that can be used to control subsampling, Auspice configuration, and more.
64+
65+
.. warning::
66+
67+
Build names currently only allow alpha characters, underscores, and hyphens, but not must not contain ``tip-frequencies`` as it is a special string used for Nextstrain builds.
68+
6469
- examples:
6570

6671
.. code:: yaml

0 commit comments

Comments
 (0)