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

Remove whitespace character that was making example changesheet invalid #846

Merged

Conversation

eecavanna
Copy link
Collaborator

@eecavanna eecavanna commented Dec 17, 2024

In this branch, I removed a whitespace character from the ID column of an example changesheet.

Details

The presence of that whitespace character made the changesheet invalid, from the perspective of the Runtime's changesheet validator.

Related issue(s)

Fixes #844

Related subsystem(s)

  • Runtime API (except the Minter)
  • Minter
  • Dagster
  • Project documentation (in the docs directory)
  • Translators (metadata ingest pipelines)
  • MongoDB migrations
  • Other

Testing

  • I tested these changes (explain below)
  • I did not test these changes

I tested these changes by manually submitting the updated changesheet to https://api.microbiomedata.org/metadata/changesheets:validate and confirming that the Runtime considers the changesheet to be valid.

Documentation

  • I have not checked for relevant documentation yet (e.g. in the docs directory)
  • I have updated all relevant documentation so it will remain accurate
  • Other (explain below)

Maintainability

  • Every Python function I defined includes a docstring (test functions are exempt from this)
  • Every Python function parameter I introduced includes a type hint (e.g. study_id: str)
  • All "to do" or "fix me" Python comments I added begin with either # TODO or # FIXME
  • I used black to format all the Python files I created/modified
  • The PR title is in the imperative mood (e.g. "Do X") and not the declarative mood (e.g. "Does X" or "Did X")

@eecavanna eecavanna self-assigned this Dec 17, 2024
@eecavanna eecavanna linked an issue Dec 17, 2024 that may be closed by this pull request
@eecavanna eecavanna requested review from aclum and dwinston December 17, 2024 19:23
@eecavanna eecavanna marked this pull request as ready for review December 17, 2024 19:23
@eecavanna
Copy link
Collaborator Author

Now that PR #845 has been merged in, the automated tests will run on this PR, since this PR includes changes to files in the paths (now) listed in the GHA workflow configuration file on the main branch.

@eecavanna
Copy link
Collaborator Author

With the changesheet having been updated as it has been in this PR, the automated tests now all pass. I will merge this in and shift my focus to the PRs that were opened earlier today (one of which introduces a pytest "skip" that would skip this then-failing test).

@eecavanna eecavanna merged commit aa087f9 into main Dec 17, 2024
1 check passed
@eecavanna eecavanna deleted the 844-runtime-api-reports-example-changesheet-as-being-invalid branch December 17, 2024 19:38
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.

Runtime API reports example changesheet as being invalid
1 participant