Skip to content

Commit

Permalink
Merge pull request #182 from smlx/readme-updates
Browse files Browse the repository at this point in the history
chore: update README around signing
  • Loading branch information
smlx authored Jul 30, 2024
2 parents a0ea324 + f5426c1 commit dfecce3
Showing 1 changed file with 1 addition and 16 deletions.
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ It also automatically builds and tests your code using [GitHub Actions](https://
* Static code analysis using [CodeQL](https://codeql.github.com/) and [Go Report Card](https://goreportcard.com/).
* Coverage analysis using the [go-test-coverage action](https://github.com/vladopajic/go-test-coverage).
* Security analysis using [OpenSSF](https://securityscorecards.dev).
* Signed binary artifacts using [Sigstore](https://www.sigstore.dev/)'s [cosign](https://github.com/sigstore/cosign).
* Signed binary artifacts using [artifact attestations](https://docs.github.com/en/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).

## How to use

Expand Down Expand Up @@ -115,18 +115,3 @@ Issues are welcome.
PRs are also welcome, but keep in mind that this is a very opinionated template, so not all changes will be accepted.
PRs also need to ensure that test coverage remains high, and best practices are followed.
## How to verify binary signatures
1. Download the three `checksums` files. They should end in `_checksums.txt`, `_checksums.txt.pem`, and `_checksums.txt.sig`.
2. Verify using [cosign](https://github.com/sigstore/cosign). For example:
```bash
cosign verify-blob \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
--certificate-identity=https://github.com/smlx/go-cli-github/.github/workflows/release.yaml@refs/heads/main \
--signature ./go-cli-github_0.13.0_checksums.txt.sig \
--cert ./go-cli-github_0.13.0_checksums.txt.pem \
./go-cli-github_0.13.0_checksums.txt
Verified OK
```

0 comments on commit dfecce3

Please sign in to comment.