chroma-core/chroma

[Bug]: Ensure `pyproject.toml` is correct as part of CI for PRs.

Open

#564 opened on May 16, 2023

View on GitHub
 (6 comments) (0 reactions) (1 assignee)Rust (27,958 stars) (2,247 forks)batch import
by-chromacleanupenhancementgood first issue

Description

What happened?

The dependencies in requirements.txt and pyproject.toml must match in order for the project to work correctly in development and when deployed.

However, there is currently no automated mechanism for ensuring that this is the case, except for the build-and-release job, which only runs on main.

We should call the bin/test-package.sh script as part of our CI on PRs to avoid this in the future.

Versions

All

Relevant log output

No response

Contributor guide

Tech stack
pythonshell
Domain
ci cd
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GitHub ActionsPython packaging basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the existing CI workflow files in the .github/workflows/ directory, particularly the build and release job. Understand how the bin/test package.sh script works and what it checks. Then add a step to run this script on pull requests, possibly in a separate job or as an additional step in an existing workflow. Check if there are any other similar checks for consistency.