-
Notifications
You must be signed in to change notification settings - Fork 638
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
Include additional fields to manifest #5314
Conversation
…anifest Signed-off-by: jorgee <[email protected]>
Signed-off-by: jorgee <[email protected]>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Co-authored-by: Ben Sherman <[email protected]> Signed-off-by: Jorge Ejarque <[email protected]>
Looks neat. Thin @ewels was suggesting to user |
Signed-off-by: jorgee <[email protected]>
Yes, changed. |
Well done! 🎉 |
Ooh awesome! Thanks @jorgee! Looks like author / maintainer fields are just strings here. Could we optionally have these as maps as well with additional subfields such as ORCiD, affiliatiob and email? See #4034 (comment) |
Think we said it would be better to keep it flat |
The BCO supports a bunch of contributor metadata as a list of maps, so you can do something like name, email, ORCID https://wiki.biocomputeobject.org/Provenance-domain#Contributors_%E2%80%9Ccontributors%E2%80%9D I think we could support this structure directly in the config. The See also: nextflow-io/nf-prov#10 |
So the list of maps is mainly to provide a more complete BCO manifest |
In fact, there is no check in the author, so you can put whatever valid expression (String, list, list of maps).
The above configuration should work. In the |
Nice! Yes some validation would be nice just to provide a base level of standardisation. Though saying that, it could be nice to allow additional arbitrary keys - eg. GitHub handle or I'm sure there are others. |
Ok so if it already works, shall we say that a short term solution is to just modify the documentation to say that it can be a string or a map? Sounds like that would be sufficient for now. We can standardise on nf-core and come back to this if needed. |
See #5314 (comment) Signed-off-by: Phil Ewels <[email protected]>
👉🏻 #5316 |
Signed-off-by: jorgee <[email protected]> Co-authored-by: Ben Sherman <[email protected]>
Include new fields in the manifest and update the documentation with the new fields