nix flake update add deprecation warnings.
#9449
Merged
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
Ericson2314
approved these changes
Nov 25, 2023
I'm heading to bed, but I put one together about a month ago. I can send it over :). |
cole-h
reviewed
Nov 25, 2023
This builds on NixOS#8817, to add additional UX help for people with existing muscle memory (or shell history) with --update-input and tries to gently guide them towards the newly evolved CLI UI. Co-authored-by: Cole Helbling <[email protected]>
angerman
force-pushed
the
angerman/improve-flake-update-ux
branch
from
869b9b7
to
af00298
Compare
|
Oh please do @grahamc. I always greatly appreciate when someone else knocks an item off my to-do list. |
tomberek
approved these changes
Nov 26, 2023
Ericson2314
added
the
backport 2.19-maintenance
| @@ -47,6 +47,16 @@ MixFlakeOptions::MixFlakeOptions() | |||
| { | |||
| auto category = "Common flake-related options"; | |||
|
|
|||
| addFlag({ | |||
| .longName = "recreate-lock-file", | |||
| .description = "Recreate the flake's lock file from scratch.", | |||
There was a problem hiding this comment.
This should also show up in documentation.
Suggested change
| .description = "Recreate the flake's lock file from scratch.", | |
| .description = R"( | |
| Recreate the flake's lock file from scratch. | |
| > **DEPRECATED** | |
| > | |
| > Use [`nix flake update`](@docroot@/command-ref/new-cli/nix3-flake-update.md) instead. | |
| )", |
Not sure about syntax and if the link is exactly right, but something along these lines.
|
Successfully created backport PR for |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-11-27-nix-team-meeting-minutes-107/36112/1 |
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.
This builds on #8817, to add additional UX help for people with existing muscle memory (or shell history) with --update-input and tries to gently guide them towards the newly evolved CLI UI.
Motivation
This change introduces a deprecation warning for the
nix flake lock --update-input INPUTcommand, guiding users towards the newernix flake update INPUTsyntax. The motivation is to enhance user experience by providing clear and helpful guidance when encountering deprecated commands. This change aligns with our ongoing efforts to streamline Nix commands and improve their intuitiveness and ease of use.Context
Many users familiar with the older
nix flake lock --update-inputsyntax may not be aware of its deprecation and the transition to the newnix flake updatecommand. The current behavior, which results in an unrecognised flag error, can be confusing and does not guide users towards the correct command. By introducing a deprecation warning, we provide a more user-friendly approach, aiding in a smoother transition to the updated syntax.Example
Before:
After:
Priorities
Add 👍 to pull requests you find important.