docs: fix missing pixi -e flags in CONTRIBUTING.md - #1541
Open
gtouloumes wants to merge 1 commit into
Open
Conversation
Every quickstart command (`pixi run test`, `test-cov`, `pre-commit ...`) omitted `-e <environment>`, so it resolved to the `default` pixi environment, which only installs bare `datajoint` — no pytest or pre-commit. Following the doc verbatim on a clean clone fails with `pytest: command not found` / `pre-commit: command not found`. Add `-e test` to the test/test-cov invocations and `-e dev` to the pre-commit invocations, matching the already-correct `-e test` usage further down in the same doc and how CI itself invokes pixi (.github/workflows/test.yaml).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Every top-level
pixi runcommand in the Quick Start and "Before Submittinga PR" sections (
pixi run test,pixi run test-cov,pixi run pre-commit ...) omits-e <environment>. Without it, pixi resolves the task againstthe
defaultenvironment, which only installs the baredatajointpackage(
[tool.pixi.pypi-dependencies]) — pytest and pre-commit only exist in thetest/devfeature environments. Following the Quick Start verbatim on aclean clone fails on the very first command:
This also left the doc inconsistent with itself (the finer-grained examples
a few lines down already use
-e test, e.g.pixi run -e test pytest tests/unit/) and with CI, which always callspixi run -e <env> ...(.github/workflows/test.yaml:55,70), never a bare
pixi run <task>.What
pixi run test/test-cov→pixi run -e test test/test-cov(Quick Start, Running Tests, External Containers, Before Submitting a PR)
pixi run pre-commit ...→pixi run -e dev pre-commit ...(Quick Start, Pre-commit Hooks, Before Submitting a PR)
Test plan
pixi run -e test pytest --versionresolves (barepixi run testpreviously failed with
pytest: command not found)pixi run -e dev pre-commit --versionresolvespixi run -e test testruns the full suite successfully (994 passed, 14 skipped)