Add image signing

[JasonN3]

Fixes #123

Summary by CodeRabbit

• Chores
  • Enhanced the continuous integration workflow to include logging into GitHub Container Registry.
  • Automated the installation of Cosign and signing of container images for tagged releases, improving security and traceability.

[JasonN3]

@coderabbitai review

[coderabbitai]

Walkthrough

Walkthrough

The recent updates to the .github/workflows/build_container.yml file introduce steps to enhance the security and integrity of container images. These updates include logging into the GitHub Container Registry, installing the Cosign tool, and signing images under specific conditions tied to GitHub references. These changes ensure that images can be verified for authenticity, fulfilling the objective of adding image signing.

Changes

File	Change Summary
.github/workflows/build_container.yml	Added steps for logging into GitHub Container Registry, installing Cosign, and conditionally signing images based on tags.

Sequence Diagram(s)

sequenceDiagram
    actor Developer
    participant GitHub Actions Workflow
    participant GitHub Container Registry (GCR)
    participant Cosign

    Developer->>GitHub Actions Workflow: Push new tag 'refs/tags/vX.X.X'
    GitHub Actions Workflow->>GCR: Login to GitHub Container Registry
    GitHub Actions Workflow->>GitHub Actions Workflow: Install Cosign if tag starts with 'refs/tags/v'
    GitHub Actions Workflow->>GCR: Build Docker images
    GitHub Actions Workflow->>Cosign: Sign images with Cosign key 
    Cosign-->>GitHub Actions Workflow: Images signed

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Add image signing (#123)	✅
Sign images based on GitHub reference conditions (#123)	✅

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 03ed84a and f345eef.

Files ignored due to path filters (1)

• cosign.pub is excluded by !**/*.pub

Files selected for processing (1)

• .github/workflows/build_container.yml (2 hunks)

Additional comments not posted (3)

.github/workflows/build_container.yml (3)

97-102: Ensure that the GitHub Token is handled securely in the login step.

The use of ${{ secrets.GITHUB_TOKEN }} for the password ensures that the token is handled securely. Good practice of using secrets in GitHub Actions.

---

122-124: Conditional execution of Cosign installation is correctly set up.

The condition if: startsWith(github.ref, 'refs/tags/v') ensures that the Cosign installation only occurs for tagged versions, which is a sensible approach to control when signing happens.

---

126-141: Review the image signing script for potential improvements in clarity and efficiency.
[REFACTOR_SUGGESTion]
The script can be refined for better readability and efficiency. Consider using a more direct approach to fetch the digest and sign the images.

- images=""
- digest=""
- for tag in ${TAGS}; do
-   if [[ -z "${digest}" ]]; then
-     digest=$(cat $(echo ${tag} | tr '/:' '--')_digest.txt)
-   fi
-   images+="${tag}@${digest} "
- done
- cosign sign --key env://COSIGN_PRIVATE_KEY --yes ${images}
+ images=$(echo ${TAGS} | xargs -n1 -I{} echo {}@$(cat $(echo {} | tr '/:' '--')_digest.txt))
+ cosign sign --key env://COSIGN_PRIVATE_KEY --yes $images

This modification uses xargs for mapping over tags and constructing the image list, which simplifies the loop and reduces the script's complexity.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.