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

cli: deprecate verify --cert #151

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

woodruffw
Copy link
Member

The long form (--certificate) is the intended option.

Closes #149.

Signed-off-by: William Woodruff william@trailofbits.com

The long form (`--certificate`) is the intended option.

Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw woodruffw added the component:cli CLI components label Jul 5, 2022
@woodruffw woodruffw requested review from di and tetsuo-cpp July 5, 2022 17:06
@woodruffw woodruffw self-assigned this Jul 5, 2022
Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw
Copy link
Member Author

As a demo:

$ sigstore verify --cert README.md.crt README.md
WARNING:sigstore._cli:--cert has been replaced with --certificate and will be removed in an upcoming stable release

@tetsuo-cpp
Copy link
Collaborator

Does cosign still use --cert? I had a quick grep and it looks like it still does.

I'll leave the judgement call to you but I tend to think that it's more important that our CLI is compatible with cosign than to be symmetrical or consistent in general.

@woodruffw
Copy link
Member Author

I'll leave the judgement call to you but I tend to think that it's more important that our CLI is compatible with cosign than to be symmetrical or consistent in general.

Yeah, that's why I wanted to get @di's opinion -- IMO we're divergent enough at this point that it makes sense to make changes that improve our UX, but this is admittedly a very small example of one of those changes 🙂

@di
Copy link
Member

di commented Jul 6, 2022

I think we should just support both as the same option for now, with no deprecation warning, to ensure this remains intuitive for cosign users as well as make sense for new users.

@woodruffw
Copy link
Member Author

Sounds good. I'll mark this as a draft then, and we can revisit if necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:cli CLI components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate the --cert alias in favor of --certificate
3 participants