feat(cli): add --no-activation option to prevent env activation during global install/upgrade #1980

183amir · 2024-09-04T13:19:37Z

Introduce the --no-activation flag in install.rs, upgrade.rs, and upgrade_all.rs to allow users to globally install executable scripts without activating the underlying conda environment. Fixes #1382

docs: update usage instructions with --no-activation flag in global cli documentation

test: add integration tests for --no-activation option in global install/upgrade paths

Hofer-Julian · 2024-09-04T14:09:04Z

Thanks for your contribution @183amir.

Two comments after a quick glance:

I am a bit hesitant to introduce a new flag to pixi global before the new implementation is released. Did you check out the proposal?
To my understanding, symlinks require admin rights on Windows. We would need to account for that

183amir · 2024-09-04T20:45:10Z

Hi @Hofer-Julian thank you for taking a look.

I understand your hesitation, but since there’s no clear timeline for the new implementation, this feature can provide immediate value and will be needed in the new implementation as well. I made sure it’s backward-compatible, so no disruption to existing workflows. Happy to adjust anything if needed!

Thanks for considering! 🙌

Hofer-Julian

I want to hold out on that one. This for sure needs more thoughts

Hofer-Julian · 2024-09-10T10:00:26Z

I'd rather try this approach first before we add a symbolic option: #1382 (comment)

183amir · 2024-09-10T12:31:10Z

Is this what you had in mind? Please let me know if this is ok.

Hofer-Julian · 2024-09-10T15:38:53Z

Is this what you had in mind? Please let me know if this is ok.

Thanks for looking into this.
I am on my phone, so I can't check a lot, but looking at your title, you are on the right track.

But no, I don't mean to add any new options, but instead add logic that only modifes the relevant env vars if the package has an activation script.

183amir · 2024-09-11T09:14:06Z

I don't think an automatic solution is possible for this. Many conda packages don't include an explicit activation script but still depend on environment variable changes that occur during conda activate, mainly relying on the modified PATH variable to locate dependency binaries. Removing the PATH modifications (and in some cases, the CONDA_PREFIX) could break certain packages. For example, a binary that relies on the ffmpeg binary being available in the PATH. That’s why I’ve added the --no-activation option as a choice rather than enforcing it by default.

Hofer-Julian · 2024-09-11T11:40:13Z

I don't think an automatic solution is possible for this. Many conda packages don't include an explicit activation script but still depend on environment variable changes that occur during conda activate, mainly relying on the modified PATH variable to locate dependency binaries. Removing the PATH modifications (and in some cases, the CONDA_PREFIX) could break certain packages. For example, a binary that relies on the ffmpeg binary being available in the PATH. That’s why I’ve added the --no-activation option as a choice rather than enforcing it by default.

You raise good points. I think I am convinced now that we need that option.

One thing that would be good to figure out later is how many packages benefit from this option. If it's only a few, important ones like pip, uv and zsh we might improve things a bit by implying this option for a few hardcoded packages.

Hofer-Julian

Thanks!

I had a few comments. After those are implemented and someone tested the PR on Windows, I think this is ready to be merged :)

docs/basic_usage.md

src/cli/global/install.rs

src/cli/global/upgrade_all.rs

Hofer-Julian · 2024-09-16T07:00:52Z

src/cli/global/upgrade.rs

+    /// Do not insert conda_prefix, path modifications, and activation script into the installed executable script.
+    #[clap(long)]
+    no_activation: bool,


Let's only add this flag to pixi global install

not sure how you would upgrade a no activation package without this option. maybe that will only be possible in the new format of global install.

Yeah, fair point. Let's add the flag to the two update commands for now then.

src/cli/global/install.rs

Hofer-Julian · 2024-09-16T07:08:55Z

Let's also revert the change to pixi.lock. I assume that happened by accident.

…lobal install/upgrade docs: update usage instructions with `--no-activation` flag in global cli documentation test: add integration tests for `--no-activation` option in global install/upgrade paths

Co-authored-by: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com>

…ds for simplification and standardization

183amir · 2024-09-20T19:32:32Z

Let's also revert the change to pixi.lock. I assume that happened by accident.

That came from running pre-commit locally but the lint passes here so I am not sure what is wrong.

183amir · 2024-09-20T19:33:04Z

The tests are failing but seems to be an issue from the main branch.

Hofer-Julian · 2024-09-21T07:09:13Z

The tests are failing but seems to be an issue from the main branch.

Yeah that seems to be the case. Next week, as soon as main is fixed I will update and test this PR. If it works as expected, I will merge it.

Hofer-Julian

Looks good to me. Let's merge this.

A first version of the new pixi global will land soon, and might not immediately feature --no-activation. Let's keep track of adding this feature soon.

This describes this recently added [functionality](prefix-dev#1980) and how it could be added to the new `pixi global`

183amir · 2024-09-23T10:07:22Z

Thank you for merging. I will be happy to reimplement this in the new version if needed.

@183amir

This describes this recently added [functionality](#1980) and how it could be added to the new `pixi global` @183amir --------- Co-authored-by: Amir Mohammadi <5738695+183amir@users.noreply.github.com>

baszalmstra approved these changes Sep 10, 2024

View reviewed changes

Hofer-Julian requested changes Sep 10, 2024

View reviewed changes

183amir force-pushed the main branch from 6227de5 to 820956a Compare September 10, 2024 11:58

183amir changed the title ~~feat(cli): add --symbolic-link option for global installations~~ feat(cli): add --no-activation option to prevent env activation during global install/upgrade Sep 10, 2024

Hofer-Julian requested changes Sep 16, 2024

View reviewed changes

ruben-arts added the area:global Related to pixi global label Sep 19, 2024

183amir and others added 4 commits September 20, 2024 20:57

feat: add --no-activation option to prevent env activation during g…

447f4c0

…lobal install/upgrade docs: update usage instructions with `--no-activation` flag in global cli documentation test: add integration tests for `--no-activation` option in global install/upgrade paths

Update src/cli/global/install.rs

1dfd5ca

Co-authored-by: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com>

Update docs/basic_usage.md

981740b

Co-authored-by: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com>

Update src/cli/global/install.rs

d3774ab

Co-authored-by: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com>

183amir force-pushed the main branch from 129e171 to 0caacac Compare September 20, 2024 19:15

refactor(cli): remove --no-activation flag from global upgrade comman…

1bb8968

…ds for simplification and standardization

183amir force-pushed the main branch from 0caacac to 1bb8968 Compare September 20, 2024 19:18

Hofer-Julian approved these changes Sep 23, 2024

View reviewed changes

Hofer-Julian merged commit e545af3 into prefix-dev:main Sep 23, 2024
38 of 42 checks passed

Hofer-Julian added a commit to Hofer-Julian/pixi that referenced this pull request Sep 23, 2024

docs: pixi global mention no-activation

10a0a7b

This describes this recently added [functionality](prefix-dev#1980) and how it could be added to the new `pixi global`

Hofer-Julian mentioned this pull request Sep 23, 2024

docs: pixi global mention no-activation #2109

Merged

BrewTestBot mentioned this pull request Oct 3, 2024

pixi 0.31.0 Homebrew/homebrew-core#192741

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): add --no-activation option to prevent env activation during global install/upgrade #1980

feat(cli): add --no-activation option to prevent env activation during global install/upgrade #1980

183amir commented Sep 4, 2024 •

edited

Loading

Hofer-Julian commented Sep 4, 2024

183amir commented Sep 4, 2024

Hofer-Julian left a comment

Hofer-Julian commented Sep 10, 2024

183amir commented Sep 10, 2024

Hofer-Julian commented Sep 10, 2024

183amir commented Sep 11, 2024

Hofer-Julian commented Sep 11, 2024

Hofer-Julian left a comment

Hofer-Julian Sep 16, 2024

183amir Sep 20, 2024

Hofer-Julian Sep 21, 2024

Hofer-Julian commented Sep 16, 2024

183amir commented Sep 20, 2024

183amir commented Sep 20, 2024

Hofer-Julian commented Sep 21, 2024

Hofer-Julian left a comment

183amir commented Sep 23, 2024

feat(cli): add --no-activation option to prevent env activation during global install/upgrade #1980

feat(cli): add --no-activation option to prevent env activation during global install/upgrade #1980

Conversation

183amir commented Sep 4, 2024 • edited Loading

Hofer-Julian commented Sep 4, 2024

183amir commented Sep 4, 2024

Hofer-Julian left a comment

Choose a reason for hiding this comment

Hofer-Julian commented Sep 10, 2024

183amir commented Sep 10, 2024

Hofer-Julian commented Sep 10, 2024

183amir commented Sep 11, 2024

Hofer-Julian commented Sep 11, 2024

Hofer-Julian left a comment

Choose a reason for hiding this comment

Hofer-Julian Sep 16, 2024

Choose a reason for hiding this comment

183amir Sep 20, 2024

Choose a reason for hiding this comment

Hofer-Julian Sep 21, 2024

Choose a reason for hiding this comment

Hofer-Julian commented Sep 16, 2024

183amir commented Sep 20, 2024

183amir commented Sep 20, 2024

Hofer-Julian commented Sep 21, 2024

Hofer-Julian left a comment

Choose a reason for hiding this comment

183amir commented Sep 23, 2024

183amir commented Sep 4, 2024 •

edited

Loading