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

Document (and test) cosign version output #3088

Closed
znewman01 opened this issue Jun 26, 2023 · 6 comments
Closed

Document (and test) cosign version output #3088

znewman01 opened this issue Jun 26, 2023 · 6 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@znewman01
Copy link
Contributor

znewman01 commented Jun 26, 2023

H/t to @vEpiphyte who observes (on Slack):

2.1.0 changed to have cosign version output print to stdout instead of stderr. The change happened in this commit:
40dbbd8
Which may come from this kubernetes-sigs/release-utils@v0.7.3...v0.7.4
specifically here
kubernetes-sigs/release-utils#76

Thanks for the detective work!

It would be useful for scripts to be able to rely on this information.
Per our versioning policy, for that to happen we need to:

  1. Document the expected STDOUT output of cosign version.
  2. Add a test that checks the output and that it's sent to the right stream.

(For a bonus, we could add a cosign version --format=json flag that output this information in a machine-friendly way.)

@znewman01 znewman01 added enhancement New feature or request good first issue Good for newcomers labels Jun 26, 2023
@vEpiphyte
Copy link

Thanks filing this!

@LewisThomas
Copy link

I'd like to try to tackle this to dip my feet into cosign codebase and Go

@znewman01
Copy link
Contributor Author

Nice! This should be a good introduction to the codebase. If when something is underdocumented and confusing, reach out here and we'll see if we can help.

@AppleGamer22
Copy link
Contributor

AppleGamer22 commented Dec 17, 2023

Since this issue has been quiet for a couple of months, I'd be happy to jump into this issue and suggest documentation updates and commits to the version printing subcommand. Would that be appropriate given this issue is already assigned?

@haydentherapper
Copy link
Contributor

Done, assigned @AppleGamer22

AppleGamer22 added a commit to AppleGamer22/cosign that referenced this issue Dec 18, 2023
partially addresses sigstore#3088

Signed-off-by: Omri Bornstein <[email protected]>
@AppleGamer22
Copy link
Contributor

I started a new branch for this issue on my fork, which at the moment contains the documentation update. I'll open the PR once I get the testing code in shape. I'm happy to open it sooner if this is required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants