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

When a user supplies their own metadata file, always consider it the source of truth. #213

Closed
8 tasks
jtyoung84 opened this issue Dec 2, 2024 · 0 comments · Fixed by #217
Closed
8 tasks
Assignees

Comments

@jtyoung84
Copy link
Contributor

User story

As a user, I want to optionally supply my own metadata file without setting any flags, so I can understand more clearly the workflow of the metadata creation.

Acceptance criteria

  • Given a user starts a GatherMetadataJob, when they have supplied their own metadata_dir and there is a <core_schema>.json file in that directory, then the GatherMetadataJob will always consider that file as the source of truth.
  • Given a user starts a GatherMetadataJob, when they have not supplied their own metadata_dir or there is no <core_schema>.json file in that directory, then the GatherMetadataJob will try to build one automatically.

Sprint Ready Checklist

  • 1. Acceptance criteria defined
  • 2. Team understands acceptance criteria
  • 3. Team has defined solution / steps to satisfy acceptance criteria
  • 4. Acceptance criteria is verifiable / testable
  • 5. External / 3rd Party dependencies identified
  • 6. Ticket is prioritized and sized

Notes

Currently, the default behavior is confusing. There is a metadata_dir_force flag that is supposed to signal when to ignore user supplied json files, but it's not clear what the default behavior is. It will be simpler to just relay to the users the behavior as described above.

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 a pull request may close this issue.

1 participant