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

feat: add provenance for SLSA3 #1393

Closed
wants to merge 1 commit into from

Conversation

COLDTURNIP
Copy link

Which issue(s) this PR fixes:

To support SASA3

@COLDTURNIP COLDTURNIP requested a review from derekbit January 13, 2025 08:57
@COLDTURNIP COLDTURNIP self-assigned this Jan 13, 2025
Copy link

coderabbitai bot commented Jan 13, 2025

Walkthrough

The pull request modifies the GitHub Actions workflow file .github/workflows/build.yml by adding the provenance: mode=max parameter to Docker image publishing steps for both AMD64 and ARM64 architectures. This configuration enhancement is applied to the docker-publish-longhorn-engine and docker-publish-longhorn-engine-with-tag steps in two separate jobs, aiming to improve image build metadata tracking without altering the existing workflow logic.

Changes

File Change Summary
.github/workflows/build.yml Added provenance: mode=max parameter to Docker publish steps in build-push-amd64-images and build-push-arm64-images jobs

Sequence Diagram

sequenceDiagram
    participant Workflow as GitHub Actions Workflow
    participant Docker as Docker Build Action
    
    Workflow->>Docker: Trigger build with provenance=mode=max
    Docker-->>Workflow: Build and publish image with enhanced metadata
Loading

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 28a533f and da8a899.

📒 Files selected for processing (1)
  • .github/workflows/build.yml (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/build.yml
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Build AMD64 binaries
  • GitHub Check: Build ARM64 binaries
  • GitHub Check: Summary

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@COLDTURNIP COLDTURNIP changed the title test(volume): add provenance for SLSA3 feat: add provenance for SLSA3 Jan 13, 2025
Copy link

@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

🧹 Nitpick comments (1)
.github/workflows/build.yml (1)

119-119: Consider documenting SLSA3 compliance.

Since this change is specifically for SLSA3 compliance, consider adding a comment in the workflow file or updating the repository documentation to indicate the SLSA3 provenance support.

Add a comment before each publish step or at the workflow level:

name: build
+# This workflow generates SLSA3 provenance for all published Docker images
on:
  push:

Also applies to: 143-143, 212-212, 236-236

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 767566a and 28a533f.

📒 Files selected for processing (1)
  • .github/workflows/build.yml (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Build AMD64 binaries
  • GitHub Check: Build ARM64 binaries
  • GitHub Check: Summary
🔇 Additional comments (1)
.github/workflows/build.yml (1)

119-119: LGTM! Consistent implementation of SLSA3 provenance.

The addition of provenance: mode=max to all Docker image publishing steps is correct and consistent with SLSA3 requirements. The changes appropriately complement the existing SBOM generation.

Let's verify that all Docker publish steps have provenance enabled:

Also applies to: 143-143, 212-212, 236-236

✅ Verification successful

✅ Verified: SLSA3 provenance correctly configured for all Docker publish steps

All four Docker image publishing steps have the required provenance: mode=max configuration:

  • AMD64 head and tag builds
  • ARM64 head and tag builds
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that all docker/build-push-action@v5 publish steps have provenance enabled
# Expected: All push: true steps should have provenance: mode=max

rg -A 10 'push: true' .github/workflows/build.yml | rg -B 10 'docker/build-push-action@v5'

Length of output: 869


Script:

#!/bin/bash
# Description: Find all docker/build-push-action@v5 steps and their configurations
# Using a wider context to ensure we catch all instances

rg -B 5 -A 15 'docker/build-push-action@v5' .github/workflows/build.yml

Length of output: 3673

@COLDTURNIP COLDTURNIP marked this pull request as draft January 13, 2025 13:38
@derekbit
Copy link
Member

In favor of #1403

@derekbit derekbit closed this Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants