-
Notifications
You must be signed in to change notification settings - Fork 3
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
Align secrets env
command with design in documentation
#212
Align secrets env
command with design in documentation
#212
Conversation
50fe2c0
to
918f42f
Compare
Did you read the docs page for this? What was written above may not be entirely matching it. Best to re-review that docs page. |
I had a look and I'm trying to align with it. That said, it mentions an |
Where does it say this?
|
Towards the bottom of the https://polykey.com/docs/how-to-guides/developers/development-environment-secrets docs. |
Rather than specifying |
Hmm well I think it's possible I might have tried to get -e to mean all variables even subdir. But actually perhaps it is not needed and globbing can be used. Like |
Also in the docs, the following doesn't align with how we create secrets.
We use |
Rather than specifying `-e <secretPath>` as a required option. You provide the secretPaths as part of the main argument now. So we provide `secrets env vault:path command arg1 arg2`. The parser expects the secret paths first. Any argument that doesn't match the secret path will be taken as part of the command args. All args are taken as command args after the first non secret path arg. [ci skip]
[ci skip]
b86e70b
to
9768aaa
Compare
Description
This PR brings the
secrets env
command in line with how it is described in the documentation.Issues Fixed
polykey secrets env
command doesn't align with Development Environment Secrets how-to-guide #176Tasks
'
single quotes, not"
double quotes.# my-software-project:AWS_SECRET_ACCESS_KEY
. We don't really want to show this information.secrets env
IS CORRECT. It is not a bug. That's howenv
regularly works. You should have tests that ensure no regression on this.polykey secrets --help
. It should be a single line in that scenario.--env
to specify the secrets you want to put into the vault is not the requirement. See the original design here: https://polykey.com/docs/how-to-guides/developers/development-environment-secrets.polykey secrets env --help:
cmd] [argv command and arguments`Final checklist