Skip to content

Attest build provenance #1844

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jun 30, 2024
Merged

Attest build provenance #1844

merged 4 commits into from
Jun 30, 2024

Conversation

shogo82148
Copy link
Owner

@shogo82148 shogo82148 commented Jun 29, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Chores
    • Updated permissions settings in GitHub workflows for better security and control.
    • Added steps to attest build provenance in various jobs.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 29, 2024 •
edited
Loading

Walkthrough

The changes made across multiple GitHub Actions workflow files (.github/workflows/darwin-arm64.yml, .github/workflows/darwin-x64.yml, .github/workflows/linux.yml, .github/workflows/win32.yml) involve updating permissions configurations for content reading/writing, id-token, and attestations. These updates ensure that the workflows have the necessary access rights for their respective tasks, enhancing security and functionality by explicitly declaring required permissions at different job steps.

Changes

File Change Summary
.github/workflows/darwin-arm64.yml Added permissions configurations for contents, id-token, and attestations in different job steps.
.github/workflows/darwin-x64.yml Added permissions configurations for contents, id-token, and attestations. Introduced actions/attest-build-provenance@v1.
.github/workflows/linux.yml Updated jobs to include permissions settings for contents, id-token, and attestations.
.github/workflows/win32.yml Added permissions configurations and included actions/attest-build-provenance@v1 step in specific jobs.

Poem

Changes spread across the workflow plains,
Permissions set, no code refrains.
Tokens, contents, attest with pride,
Our CI/CD now fortified.
A rabbit's joy in code so bright,
GitHub Actions, set just right! 🌟🐇

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Jun 29, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 145ac4c and b0091d0.

Files selected for processing (4)
  • .github/workflows/darwin-arm64.yml (6 hunks)
  • .github/workflows/darwin-x64.yml (6 hunks)
  • .github/workflows/linux.yml (6 hunks)
  • .github/workflows/win32.yml (6 hunks)
Additional comments not posted (24)
.github/workflows/linux.yml (6)

24-25: Permissions settings for list job look appropriate.

The permissions are set to read-only for contents, which is suitable for a job that lists available Perl versions without modifying any resources.

43-44: Permissions settings for sanity-check job look appropriate.

Setting the permissions to read-only for contents is appropriate for a job that checks pre-installed Perl versions and performs sanity checks without modifying any resources.

72-75: Permissions settings for build job look appropriate.

The permissions are expanded to include write access for contents, id-token, and attestations which aligns with the job's requirements to perform builds, handle authentication, and manage build attestations.

114-117: Proper integration of actions/attest-build-provenance@v1.

The step correctly configures the subject-path for the build artifact, which is crucial for attesting build provenance. Ensure that the path is correctly referenced and accessible at this stage of the workflow.

131-134: Permissions settings for build-multi-thread job look appropriate.

Similar to the build job, the permissions settings are appropriately configured to allow necessary write operations and handling of build attestations for multi-threaded builds.

167-170: Proper integration of actions/attest-build-provenance@v1 for multi-threaded build.

The configuration is consistent with the single-threaded build, ensuring that build provenance is attested correctly. Validation of the subject-path remains important.

.github/workflows/darwin-x64.yml (6)

24-25: Permissions settings for list job look appropriate.

The permissions are set to read-only for contents, which is suitable for a job that lists available Perl versions without modifying any resources.

43-44: Permissions settings for sanity-check job look appropriate.

Setting the permissions to read-only for contents is appropriate for a job that checks pre-installed Perl versions and performs sanity checks without modifying any resources.

72-75: Permissions settings for build job look appropriate.

The permissions are expanded to include write access for contents, id-token, and attestations which aligns with the job's requirements to perform builds, handle authentication, and manage build attestations.

114-117: Proper integration of actions/attest-build-provenance@v1.

The step correctly configures the subject-path for the build artifact, which is crucial for attesting build provenance. Ensure that the path is correctly referenced and accessible at this stage of the workflow.

131-134: Permissions settings for build-multi-thread job look appropriate.

Similar to the build job, the permissions settings are appropriately configured to allow necessary write operations and handling of build attestations for multi-threaded builds.

175-178: Proper integration of actions/attest-build-provenance@v1 for multi-threaded build.

The configuration is consistent with the single-threaded build, ensuring that build provenance is attested correctly. Validation of the subject-path remains important.

.github/workflows/darwin-arm64.yml (6)

24-25: Permissions settings for list job look appropriate.

The permissions are set to read-only for contents, which is suitable for a job that lists available Perl versions without modifying any resources.

43-44: Permissions settings for sanity-check job look appropriate.

Setting the permissions to read-only for contents is appropriate for a job that checks pre-installed Perl versions and performs sanity checks without modifying any resources.

72-75: Permissions settings for build job look appropriate.

The permissions are expanded to include write access for contents, id-token, and attestations which aligns with the job's requirements to perform builds, handle authentication, and manage build attestations.

114-117: Proper integration of actions/attest-build-provenance@v1.

The step correctly configures the subject-path for the build artifact, which is crucial for attesting build provenance. Ensure that the path is correctly referenced and accessible at this stage of the workflow.

131-134: Permissions settings for build-multi-thread job look appropriate.

Similar to the build job, the permissions settings are appropriately configured to allow necessary write operations and handling of build attestations for multi-threaded builds.

175-178: Proper integration of actions/attest-build-provenance@v1 for multi-threaded build.

The configuration is consistent with the single-threaded build, ensuring that build provenance is attested correctly. Validation of the subject-path remains important.

.github/workflows/win32.yml (6)

24-25: Permissions set correctly for the list job.

This ensures the job has the necessary access to perform its operations securely.

43-44: Permissions set correctly for the sanity-check job.

This ensures the job has the necessary access to perform its operations securely.

79-82: Permissions set correctly for the build job.

This ensures the job has the necessary access to perform its operations securely, especially with the new attest-build-provenance step.

163-166: Attest-build-provenance step added correctly.

This step enhances security and traceability by attesting the build provenance with a specific subject path.

183-186: Permissions set correctly for the build-multi-thread job.

This ensures the job has the necessary access to perform its operations securely, especially with the new attest-build-provenance step.

262-265: Attest-build-provenance step added correctly in multi-thread build.

This step enhances security and traceability by attesting the build provenance with a specific subject path in the multi-thread build job.

coderabbitai[bot]
coderabbitai bot reviewed Jun 29, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b0091d0 and 1dd1551.

Files selected for processing (1)
  • .github/workflows/linux.yml (6 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/linux.yml

coderabbitai[bot]
coderabbitai bot reviewed Jun 29, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1dd1551 and 1ce3f79.

Files selected for processing (4)
  • .github/workflows/darwin-arm64.yml (5 hunks)
  • .github/workflows/darwin-x64.yml (5 hunks)
  • .github/workflows/linux.yml (5 hunks)
  • .github/workflows/win32.yml (5 hunks)
Files skipped from review as they are similar to previous changes (4)
  • .github/workflows/darwin-arm64.yml
  • .github/workflows/darwin-x64.yml
  • .github/workflows/linux.yml
  • .github/workflows/win32.yml

@shogo82148 shogo82148 merged commit 522a126 into main Jun 30, 2024
@shogo82148 shogo82148 deleted the attest-build-provenance branch June 30, 2024 04:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@shogo82148