feat(ci): support signed release #2184
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces support for signed releases by integrating cosign into the release process.
- Adds a new "signs" section in the GoReleaser configuration to sign artifacts using cosign.
- Updates the GitHub Actions workflow with additional id-token permissions and a step to install cosign.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .goreleaser.yml | Introduces a new signs section to configure artifact signing with cosign. |
| .github/workflows/goreleaser.yml | Updates permissions for id-token and adds a Cosign installation step. |
There was a problem hiding this comment.
Pull Request Overview
This PR introduces artifact signing using cosign to improve the “Signed releases” score for the project. Key changes include:
- Adding a signing configuration block in .goreleaser.yml to configure cosign.
- Updating the GitHub Actions workflow to include id-token permissions and a cosign installation step.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .goreleaser.yml | Added a "signs" block to configure cosign for artifact signing in the release process. |
| .github/workflows/goreleaser.yml | Updated permissions (id-token) and added a step to install cosign prior to other build steps. |
Comments suppressed due to low confidence (1)
.goreleaser.yml:161
- Consider adding tests or verification procedures for the new cosign signing configuration to ensure that artifacts are signed correctly during a release.
signs:
MaineK00n
changed the title
shino
reviewed
Apr 25, 2025
Comment on lines
+168
to
+173
| - "sign-blob" | ||
| - "--oidc-issuer=https://token.actions.githubusercontent.com" | ||
| - "--output-certificate=${certificate}" | ||
| - "--output-signature=${signature}" | ||
| - "${artifact}" | ||
| - "--yes" |
There was a problem hiding this comment.
Suggested change
| - "sign-blob" | |
| - "--oidc-issuer=https://token.actions.githubusercontent.com" | |
| - "--output-certificate=${certificate}" | |
| - "--output-signature=${signature}" | |
| - "${artifact}" | |
| - "--yes" | |
| - "sign-blob" | |
| - "--oidc-issuer=https://token.actions.githubusercontent.com" | |
| - "--output-certificate=${certificate}" | |
| - "--output-signature=${signature}" | |
| - "${artifact}" | |
| - "--yes" |
I prefer the indent style you wrote, but other parts in this file does not add indentation for list, hmm...
shino
reviewed
Apr 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, the “Signed releases” score in our OpenSSF Scorecard is zero, so we’d like to fix this.
https://scorecard.dev/viewer/?uri=github.com%2Ffuture-architect%2Fvuls
This pull request introduces changes to enable artifact signing using
cosignin the GoReleaser workflow. The most important updates include adding permissions and steps forcosignin the GitHub Actions workflow and configuringcosignsigning in the GoReleaser configuration.GitHub Actions workflow updates:
.github/workflows/goreleaser.yml: Addedid-token: readandid-token: writepermissions to enablecosignfunctionality. Included a step to installcosignusingsigstore/cosign-installer.GoReleaser configuration updates:
.goreleaser.yml: Added asignssection to configurecosignfor signing artifacts. This includes setting environment variables, specifying signature and certificate outputs, and defining the signing command and arguments.# What did you implement:Type of change
How Has This Been Tested?
I haven’t tested it. Please proceed with the plan to run it in the next release and, if it doesn’t work, fix it on the spot.
Checklist:
make fmtmake test***Is this ready for review?:***YES