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

Workflow best practices: check that creator identifiers are URIs #1458

Merged
merged 3 commits into from
Jul 4, 2024

Conversation

elichad
Copy link
Contributor

@elichad elichad commented Jun 26, 2024

From https://github.com/galaxyproject/iwc/blob/main/workflows/README.md#ensure-workflows-follow-best-practices :

The "Identifier" field of a Creator added as a person should be filled with a fully qualified URI, e.g., https://orcid.org/0000-0002-1825-0097.

This PR adds a check which will emit a warning if a workflow creator is a person and their identifier is not a URI.

I'm aware this function is meant to mirror the Galaxy UI - I can try and make a matching PR for the UI, though I'm weaker on Vue/JS than Python. Thought I would open this PR first to confirm if that's worthwhile.

Context for the PR: my team is scraping Galaxy workflow RO-Crates from WorkflowHub and found a few where the generated author metadata uses just the ORCID number for the @id rather than the full ORCID URI. We are keen to help reduce those cases through improved linting!

planemo/workflow_lint.py Outdated Show resolved Hide resolved
Copy link
Member

@mvdbeek mvdbeek left a comment

Choose a reason for hiding this comment

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

I've taken the liberty to push a minor change. Nice to see another contribution from you!

@mvdbeek mvdbeek enabled auto-merge July 4, 2024 10:17
@elichad
Copy link
Contributor Author

elichad commented Jul 4, 2024

Thanks @mvdbeek, fine with me! Sorry for not getting back to your comments sooner.

I haven't seen any workflows where the creator is not a list - I just wasn't sure if this could theoretically happen and pass validation elsewhere.

@mvdbeek mvdbeek merged commit 06de31d into galaxyproject:master Jul 4, 2024
14 checks passed
@elichad elichad deleted the check-creator-identifier branch July 4, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants