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

BUG docs haven't been updated to say that Signed-Releases looks for .sigstore bundles. #3914

Closed
cpswan opened this issue Mar 4, 2024 · 2 comments · Fixed by #3922
Closed
Labels
check/Signed-Releases good first issue Good for newcomers kind/bug Something isn't working

Comments

@cpswan
Copy link
Contributor

cpswan commented Mar 4, 2024

Describe the bug
#3772 introduced .sigstore to the Signed-Releases check but the documentation doesn't mention it.

Reproduction steps
Steps to reproduce the behavior:

  1. Take a look at

    scorecard/docs/checks.md

    Lines 594 to 597 in 90a3708

    This check looks for the following filenames in the project's last five
    [release assets](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases):
    [*.minisig](https://github.com/jedisct1/minisign), *.asc (pgp),
    *.sig, *.sign, [*.intoto.jsonl](https://slsa.dev).
  2. Then
    var signatureExtensions = []string{".asc", ".minisig", ".sig", ".sign", ".sigstore"}

Expected behavior
Documentation matches code

Additional context
Check doesn't seem to work as expected with .sigstore bundles #3913

@cpswan cpswan added the kind/bug Something isn't working label Mar 4, 2024
@spencerschrock
Copy link
Contributor

Are you interested in sending a PR? We have instructions for updating documentation:
https://github.com/ossf/scorecard/blob/main/CONTRIBUTING.md#updating-docs

@cpswan
Copy link
Contributor Author

cpswan commented Mar 4, 2024

@spencerschrock yeah, I'm happy to do a docs PR, so please assign to me.

Though should we wait for the functionality to be released before the docs are updated?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
check/Signed-Releases good first issue Good for newcomers kind/bug Something isn't working
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants