refactor: Make self-update a compile time feature #2213
Merged
+69
−57
Conversation
This file contains 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
Currently pixi refuses to self-update if it is not installed at its default location. This can be overridden using the `--force` flag. This is not ideal for two reasons: Some people might intentionally install pixi to a non-default location, such as `~/.local/bin/pixi`, while not using a package manager. On the other hand, passing `--force` still allows pixi installations installed by a package manager to be broken. A better solution would be disabling the self-update functionallity at compile time. This PR adds a compile-time feature called `self_update`, which is not enabled by default. This PR also enables this feature in the CI build so releases produced by CI can still be self-updated. Because the feature is not enabled by default, other distributions of pixi, such as when built by other package managers, will not support self-update. Instead of completely removing the self-update sub-command, disabling this feature only replaces it with a stub command that outputs an error message. This is to prevent user-confusion, when users read about self-update in documentation, only to find the sub-command missing in their installation. With this implemented the default location check and `--force` flag will not be needed anymore.
freundTech
force-pushed
the
self-update-feature
branch
from
d5ee170
to
b905b39
Compare
freundTech
changed the title
freundTech
force-pushed
the
self-update-feature
branch
from
1df8786
to
b905b39
Compare
freundTech
force-pushed
the
self-update-feature
branch
from
585994b
to
a717571
Compare
Hofer-Julian
reviewed
Oct 7, 2024
There was a problem hiding this comment.
Hey @freundTech, thanks for your contribution. I haven't tested it yet, but the spirit of this PR looks good to me.
wolfv
reviewed
Oct 7, 2024
freundTech
force-pushed
the
self-update-feature
branch
from
7a2b4ab
to
db0d922
Compare
Co-authored-by: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com>
The top level header is inserted automatically
freundTech
force-pushed
the
self-update-feature
branch
from
af5ac9e
to
19817e4
Compare
|
Thanks for this PR, I think it should be ready. I'll wait with the merge for a little bit as we're dealing with some nasty Rust 1.81 issues and I don't want to mix this PR into to Rust issues. |
Hofer-Julian
reviewed
Oct 8, 2024
pavelzw
approved these changes
Oct 9, 2024
ruben-arts
approved these changes
Oct 11, 2024
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently pixi refuses to self-update if it is not installed at its default location. This can be overridden using the
--forceflag.This is not ideal for two reasons: Some people might intentionally install pixi to a non-default location, such as
~/.local/bin/pixi, while not using a package manager. On the other hand, passing--forcestill allows pixi installations installed by a package manager to be broken.A better solution would be disabling the self-update functionallity at compile time. This PR adds a compile-time feature called
self_update, which is not enabled by default.This PR also enables this feature in the CI build so releases produced by CI can still be self-updated. Because the feature is not enabled by default, other distributions of pixi, such as when built by other package managers, will not support self-update.
Instead of completely removing the self-update sub-command, disabling this feature only replaces it with a stub command that outputs an error message. This is to prevent user-confusion, when users read about self-update in documentation, only to find the sub-command missing in their installation.
With this implemented the default location check and
--forceflag will not be needed anymore.