Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dashes in pipeline names / versions #1819

Open
Lestropie opened this issue May 15, 2024 · 0 comments
Open

Dashes in pipeline names / versions #1819

Lestropie opened this issue May 15, 2024 · 0 comments
Labels
derivatives opinions wanted Please read and offer your opinion on this matter

Comments

@Lestropie
Copy link
Collaborator

In "Common principles", "Storage of derived datasets":

it is RECOMMENDED to use the format <pipeline>-<variant> in cases where it is anticipated that the same pipeline will output more than one variant

The dash here acts as a delimiter in a comparable way to that of Entities in file names.
In the context of entities, the dash character must be excluded from both key and value strings in order for the delimitation to be unambiguous.
It seems to me that if it is desired for pipeline derivatives to be more standardised, then pipeline names and versions must also be explicitly forbidden by the specification from containing dash characters.

Quick vote:

  • 👍 : Modify specification to enforce that if a dash appears in a pipeline directory name, there must be only one, and its purpose must be to delimit pipeline name from version.
  • 👎 : Pipeline derivatives directory names remain freeform; this structure remains a recommendation for human navigation only; machine parsing of derivatives should rely not on these names but the metadata contained within.
@Lestropie Lestropie added derivatives opinions wanted Please read and offer your opinion on this matter labels May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
derivatives opinions wanted Please read and offer your opinion on this matter
Projects
None yet
Development

No branches or pull requests

1 participant