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

Add manifest.contributors config option #5322

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

bentsherman
Copy link
Member

Close #4034

Deprecate manifest.author, remove manifest.maintainer from #5314 , and add manifest.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.

Copy link

netlify bot commented Sep 23, 2024

Deploy Preview for nextflow-docs-staging canceled.

Name Link
🔨 Latest commit 005624c
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/67069795e6704a0008621077

docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
Copy link
Contributor

@pinin4fjords pinin4fjords left a 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

docs/config.md Outdated Show resolved Hide resolved
Copy link
Member

@pditommaso pditommaso left a 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

@bentsherman
Copy link
Member Author

@pditommaso regarding the tower client, the only touchpoint I see with the manifest config is when sending the resolved config:

workflow.configText = session.resolvedConfig

At this point the config has been rendered to a string so the Manifest class is no longer involved

@pditommaso
Copy link
Member

I think it gets serialised with the workflow metadata here

def workflow = session.getWorkflowMetadata().toMap()

@bentsherman
Copy link
Member Author

@pditommaso thanks, I see it now

@ewels what was the rationale for the organisation option? is it still needed if the contributors can have an affiliation?

also, didn't we standardize around American English...

@ewels
Copy link
Member

ewels commented Oct 1, 2024

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..

@bentsherman bentsherman added this to the 24.10.0 milestone Oct 6, 2024
@pditommaso
Copy link
Member

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Additional manifest config fields
7 participants