Move Shelley commands to the top-lvl and deprecate "shelley" subcommand #2076
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
intricate
force-pushed
the
intricate/deprecate-shelley-subcmd
branch
from
a4661aa
to
7b8d432
Compare
|
We should also think about how we are going to update the cli tests. |
Jimbo4350
reviewed
Nov 11, 2020
| -- the provided 'ExceptT'. | ||
| ioExceptTWithWarning :: MonadIO m => Text -> ExceptT e m () -> ExceptT e m () | ||
| ioExceptTWithWarning warningMsg e = | ||
| liftIO (Text.hPutStrLn stderr warningMsg) >> e |
There was a problem hiding this comment.
I personally wouldn't bother with defining two new functions, seems verbose when
liftIO (Text.hPutStrLn stderr warningMsg) >> e on its own would do with a comment. Your call though!
There was a problem hiding this comment.
I was considering reusing this for other deprecated commands/arguments.
For example, after #1979 is merged, I'm considering whether we should print deprecation warnings when hex or TextEnvelope keys are specified.
intricate
requested review from
dcoutts,
erikd,
mrBliss and
newhoggy
as code owners
intricate
force-pushed
the
intricate/deprecate-shelley-subcmd
branch
from
7b8d432
to
2eedb24
Compare
intricate
force-pushed
the
intricate/deprecate-shelley-subcmd
branch
from
2eedb24
to
fc43c20
Compare
|
bors merge |
iohk-bors bot
added a commit
that referenced
this pull request
Nov 23, 2020
2076: Move Shelley commands to the top-lvl and deprecate "shelley" subcommand r=dcoutts a=intricate This PR moves Shelley-related commands from under the "shelley" subcommand to the top-level of the CLI. We still maintain support for the "shelley" subcommand (i.e. all of the commands still work), but its help text is hidden. However, the help text can still be accessed by running `cardano-cli shelley` or `cardano-cli shelley --help`: ``` $ cardano-cli shelley Usage: cardano-cli shelley COMMAND Shelley specific commands (deprecated) Available options: -h,--help Show this help text Available commands: ... ``` Additionally, a warning message is written to `stderr` when one attempts to run a command under the "shelley" subcommand. Example: ``` $ cardano-cli shelley address key-gen --verification-key-file /dev/null --signing-key-file /dev/null WARNING: The "shelley" subcommand is now deprecated and will be removed in the future. Please use the top-level commands instead. ``` Co-authored-by: Luke Nadur <19835357+intricate@users.noreply.github.com>
|
Timed out. |
|
bors r+ |
|
Build succeeded: |
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 PR moves Shelley-related commands from under the "shelley" subcommand to the top-level of the CLI.
We still maintain support for the "shelley" subcommand (i.e. all of the commands still work), but its help text is hidden. However, the help text can still be accessed by running
cardano-cli shelleyorcardano-cli shelley --help:Additionally, a warning message is written to
stderrwhen one attempts to run a command under the "shelley" subcommand. Example: