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

Adding basic testing workflow to check qudi-core installs. #139

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

prithviulm
Copy link
Contributor

@prithviulm prithviulm commented Feb 10, 2025

Description

As suggested by @TobiasSpohn, a simple test to check that qudi-core installs properly can be helpful to identify issues with dependencies. This can be expanded to a basic check that the module manager loads as well. Also, there is another plan to do an automatic check that both qudi-core and qudi-iqo-modules pass their respective tests whenever a dependency has a version bump.

Motivation and Context

When preparing a release for Qudi, we often fix dependencies but there can be conflicts that are not easy to find without permuting various installations. Also, dependecies often undergo version bumps and can cause breaking changes that are hard to trace back. Running the tests when a version bump is detected would be helpful to isolate these incidents.

How Has This Been Tested?

The tests run as expected on Github Actions.

Types of changes

  • Bug fix
  • New feature
  • Breaking change (Causes existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • I have documented my changes in /docs/changelog.md.
  • My change requires additional/updated documentation.
  • I have updated the documentation accordingly.
  • I have added/updated the config example for any module docstrings as necessary.
  • I have checked that the change does not contain obvious errors
    (syntax, indentation, mutable default values, etc.).
  • I have tested my changes using 'Load all modules' on the default dummy configuration.
  • All changed Jupyter notebooks have been stripped of their output cells.

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.

1 participant