-
Notifications
You must be signed in to change notification settings - Fork 621
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
Add manifest.contributors
config option
#5322
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Ben Sherman <[email protected]>
✅ Deploy Preview for nextflow-docs-staging canceled.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice flexible solution, makes sense
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Worth to add some tests in the Tower client. This info needs likely to be collected in Platform
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
@pditommaso regarding the tower client, the only touchpoint I see with the manifest config is when sending the resolved config:
At this point the config has been rendered to a string so the Manifest class is no longer involved |
I think it gets serialised with the workflow metadata here
|
@pditommaso thanks, I see it now @ewels what was the rationale for the also, didn't we standardize around American English... |
I guess a pipeline could have a different organisation to its contributors? Such as organisation: @nf-core But it's a bit of a stretch, happy for that one to be dropped if it was only just added 👍🏻 US English is fine by me. Apologies if it was me who introduced that. My fingers aren't capable of following instructions on this score.. |
Looks there are failing tests, right? |
Signed-off-by: Ben Sherman <[email protected]>
- `name`: the contributor's name | ||
- `affiliation`: the contributor's affiliated organization | ||
- `email`: the contributor's email address | ||
- `github`: the contributor's GitHub URL |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- `github`: the contributor's GitHub URL | |
- `github`: the contributor's Git(Hub/Lab etc.) URL |
Re @pditommaso 's comment, what about this instead to make it clearer it's just the handle you use in any git context?
Also do you give the full URL or just the handle itself?
Close #4034
Deprecate
manifest.author
, removemanifest.maintainer
from #5314 , and addmanifest.contributors
which is a list of maps. The maps are converted to records under the hood.Contribution types include "author" and "maintainer". The BCO spec is based on PAV ontology which includes "createdBy", "authoredBy", and "curatedBy". I think we can map author -> authoredBy and maintainer -> curatedBy. Not sure that we need a "creator" option separate from "author". But this ontology seems to be the standard across multiple provenance formats.