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

Create HDMF_dev.yaml #136

Merged
merged 13 commits into from
Nov 1, 2023
Merged

Create HDMF_dev.yaml #136

merged 13 commits into from
Nov 1, 2023

Conversation

mavaylon1
Copy link
Contributor

@mavaylon1 mavaylon1 commented Nov 1, 2023

Motivation

What was the reasoning behind this change? Please explain the changes briefly.

This introduces a new workflow to run the tests on HDMF-Zarr using the dev branch of HDMF.

How to test the behavior?

Show how to reproduce the new behavior (can be a bug fix or a new feature)

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running ruff from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

@codecov-commenter
Copy link

codecov-commenter commented Nov 1, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (70bf35b) 85.92% compared to head (5185146) 85.92%.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #136   +/-   ##
=======================================
  Coverage   85.92%   85.92%           
=======================================
  Files          13       13           
  Lines        3189     3189           
=======================================
  Hits         2740     2740           
  Misses        449      449           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mavaylon1
Copy link
Contributor Author

Fix #126

@mavaylon1
Copy link
Contributor Author

@oruebel As I was making this, I started to think about how much did we want to test. Within tox.ini, it installs the latest release of HDMF. It will run pytest according to different environment versions.

Now ideally, this workflow could do something like that, but we can't use tox.ini because we would have to edit the install requirements to use the dev branch. What I have now is a proof of concept that it works for only python 3.11. Do we want this workflow to only do that or should we get creative and test for all python versions?

@rly
Copy link
Contributor

rly commented Nov 1, 2023

@mavaylon1 I think testing on python 3.11 (or whatever is the latest version supported by both packages) is sufficient. We could test this workflow on all python versions, on all OSs, with minimum, pinned, upgraded, and pre-release requirements, but I think that is overkill and unlikely to catch issues.

@rly
Copy link
Contributor

rly commented Nov 1, 2023

Unlikely to catch any issues that testing on each package independently would not catch.

@mavaylon1
Copy link
Contributor Author

Unlikely to catch any issues that testing on each package independently would not catch.

Agreed.

@mavaylon1
Copy link
Contributor Author

Since this is a workflow change, I am not updating the Changelog

@mavaylon1 mavaylon1 self-assigned this Nov 1, 2023
@mavaylon1 mavaylon1 marked this pull request as ready for review November 1, 2023 19:37
@mavaylon1 mavaylon1 requested a review from rly November 1, 2023 19:37
Copy link
Contributor

@rly rly left a comment

Choose a reason for hiding this comment

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

LGTM

@mavaylon1 mavaylon1 merged commit efe83d1 into dev Nov 1, 2023
23 checks passed
@mavaylon1 mavaylon1 deleted the hdmf_workflow branch November 1, 2023 19:46
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.

3 participants