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

Configure GHA to run tests when example changesheets change #845

Conversation

eecavanna
Copy link
Collaborator

In this branch, I updated a GitHub Actions workflow so that it is triggered by more events.

Details

Specifically, I updated it so it is triggered by the event in which a file in the data directory (in which example changesheets reside) changes.

This is in an attempt to catch regression bugs at the PR stage, instead of allowing them to end up in main. A recent incident of a regression bug making it into main via a PR is when #841 was merged.

Related issue(s)

Fixes #843

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 did not test these changes locally. I will find out whether they suffice once they are merged into main and someone opens a PR that contains changes to the files in the newly-specified directory.

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 marked this pull request as ready for review December 17, 2024 18:48
@eecavanna eecavanna requested review from dwinston and aclum December 17, 2024 18:49
@eecavanna
Copy link
Collaborator Author

On GHA, only 1 test is failing and it is the test that I expect to be failing.

tests/test_api/test_metadata.py F...s....                                [ 38%]

The failure is partially a result of this GHA configuration not being present in the repo. I will merge this in so that this new GHA configuration becomes present in main (the GHA configuration that exists in main is the only configuration GHA considers), then I will merge in PR #846, which I expect to resolve this 1 failing test.

@eecavanna eecavanna merged commit 3ae3d01 into main Dec 17, 2024
1 check failed
@eecavanna eecavanna deleted the 843-gha-does-not-run-automated-tests-when-example-changesheets-are-modified branch December 17, 2024 19:27
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.

GHA does not run automated tests when example changesheets are modified
1 participant