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

Rename key-store-path command line option #586

Closed
2 tasks done
jframe opened this issue Jun 1, 2022 · 4 comments
Closed
2 tasks done

Rename key-store-path command line option #586

jframe opened this issue Jun 1, 2022 · 4 comments
Assignees
Labels
snack Small coding task TeamCerberus Under active development by TeamCerberus @Consensys

Comments

@jframe
Copy link
Contributor

jframe commented Jun 1, 2022

Rename the command line option --key-store-path as it is confusing since it implies that it is related to key stores. This is the key config directory and is for more than just keystore files. It is also similar in name the recently added keystore bulk loading command line options https://docs.web3signer.consensys.net/en/latest/Reference/CLI/CLI-Subcommands/#keystores-path.

Tasks

  • Keep old name as an alias and deprecate
  • New name

Note to dev: Make sure to specify the new cli option as the first option so that any error reporting by PicoCli mentions new option, for example:

  @Option(
      names = {"--key-config-path", "--key-store-path"},
      description = "The path to a directory storing yaml files defining available keys",

The AT should test key-config-path and key-store-path i.e. both the new and deprecated value and make sure that the config file AT picks them up.

@jframe jframe added the TeamCerberus Under active development by TeamCerberus @Consensys label Jun 1, 2022
@siladu siladu added the doc-change-required Indicates an issue or PR that requires doc to be updated label Jun 13, 2022
@james-prysm
Copy link

was there some info on what it would be changed to ?

@jframe
Copy link
Contributor Author

jframe commented Jul 3, 2022

@james-prysm No decision has been made on what the name would change to. Was thinking --key-config-path would work well but that's not locked in yet. Will update this ticket once we decide on the new command line option name.

@siladu
Copy link
Contributor

siladu commented Jun 29, 2023

@james-prysm we went with --key-config-path but --key-store-path still works

@siladu siladu closed this as completed Jun 29, 2023
@james-prysm
Copy link

awesome thanks for letting me know

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
snack Small coding task TeamCerberus Under active development by TeamCerberus @Consensys
Projects
None yet
Development

No branches or pull requests

5 participants
@jframe @siladu @alexandratran @james-prysm and others