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

feat: add deprecation notice for depends_on #2891

Merged
merged 2 commits into from
Jan 14, 2025

Conversation

baszalmstra
Copy link
Contributor

This PR reverts the deprecation error on depends_on in favor of a deprecation warning.

We did not really have a way to signal warnings like deprecations in the manifest. This PR adds a simple mechanism to collect warnings during parsing. These warnings are emitted after the project is parsed. Im a little unsure whether it makes sense to just emit them or if we should add a method to emit them.

An example when running pixi list --no-install on the holoviews repository.

 WARN Encountered 2 warnings while parsing the manifest:

  ⚠ The `depends_on` field is deprecated. Use `depends-on` instead.
     ╭─[pixi.toml:136:1]
 135 │ cmd = 'pytest holoviews/tests/ui --ui --browser chromium'
 136 │ depends_on = ["_install-ui"]
     · ─────┬────
     ·      ╰── replace this with 'depends-on'
 137 │
     ╰────


  ⚠ The `depends_on` field is deprecated. Use `depends-on` instead.
     ╭─[pixi.toml:180:1]
 179 │ [feature.doc.tasks.docs-build]
 180 │ depends_on = ['_docs-generate-rst', '_docs-refmanual', '_docs-generate']
     · ─────┬────
     ·      ╰── replace this with 'depends-on'
 181 │
     ╰────

Fixes: #2888

@baszalmstra baszalmstra added the UX Related to the User Experience of pixi label Jan 13, 2025
Copy link
Contributor

@Hofer-Julian Hofer-Julian left a comment

Choose a reason for hiding this comment

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

Looks good, thanks @baszalmstra!

One small comment, then it can go in from my side.

@ruben-arts ruben-arts merged commit 4ed68a4 into prefix-dev:main Jan 14, 2025
28 checks passed
flferretti added a commit to ami-iit/jaxsim that referenced this pull request Feb 10, 2025
This PR updates the `pixi` configuration option as per prefix-dev/pixi#2891
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
UX Related to the User Experience of pixi
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change to depends_on only notifies for one use at a time.
3 participants