Skip to content

Add optional metadata validation for module manifests - #425

Open
Tanvip2602 wants to merge 1 commit into
KarchinLab:masterfrom
Tanvip2602:issue-370-optional-metadata
Open

Add optional metadata validation for module manifests#425
Tanvip2602 wants to merge 1 commit into
KarchinLab:masterfrom
Tanvip2602:issue-370-optional-metadata

Conversation

@Tanvip2602

@Tanvip2602 Tanvip2602 commented Aug 30, 2026

Copy link
Copy Markdown

Description

Adds optional metadata validation for OpenCRAVAT module info.yaml manifests.

1.Changes

  • Added validate_manifest.py for manifest validation.
  • Added validation for optional fields:
    • homepage
    • contact
    • license
  • Missing optional fields generate warnings instead of errors.
  • Added pytest unit tests for complete and incomplete manifests.
  • Added usage instructions to tests/README.md.
  1. Testing
  • Tested complete manifests.
  • Tested manifests with missing optional fields.
  • Tested missing required fields.
  • Tested invalid YAML.
  • All 4 unit tests passed.

Closes #370

@kmoad

kmoad commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

Thanks for the PR! We'll look it over and get back to you soon.

@kmoad

kmoad commented Sep 7, 2026

Copy link
Copy Markdown
Collaborator

This looks good and fulfills requirements.

Could you move it under the cravat directory, instead or project root.

After that, we think it's good to merge.

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.

Add optional metadata field validation for modules

2 participants