Skip to content

Add CI Workflow to Validate Tutorials for Backward Compatibility and Online #5293

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

Open
YassinNouh21 opened this issue Apr 23, 2025 · 0 comments
Labels
kind/feature New feature or request

Comments

@YassinNouh21
Copy link
Contributor

YassinNouh21 commented Apr 23, 2025

Is your feature request related to a problem? Please describe.
Yes. Tutorials and example scripts (e.g., milvus_example.py) can silently break when there are updates to online stores or deprecated dependencies. There's no CI to validate these examples after such changes, which leads to user complaints about broken tutorials — especially after major updates to the development of specific online stores.

Describe the solution you'd like
Add a GitHub Actions CI workflow that automatically:

  • Runs all tutorials and example scripts under examples/online_store/**.
  • Validates compatibility whenever core components (like online stores) are modified.
  • Surfaces issues when changes break tutorials, ensuring everything stays in sync.

This would catch regressions early and align examples with development changes.

Describe alternatives you've considered

  • Manual testing of tutorials before releases (not scalable).
  • Relying on user reports or contributors to notice breakages (reactive, not ideal).
@YassinNouh21 YassinNouh21 added the kind/feature New feature or request label Apr 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant