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

fix: image scan issue with github branch name #2896

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

pratapalakshmi
Copy link
Collaborator

@pratapalakshmi pratapalakshmi commented Dec 15, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced tagging of Docker images to include Git commit SHA for better traceability.
    • Updated image scanning process to reference images by commit SHA.
  • Bug Fixes

    • Improved accuracy in vulnerability scanning by linking it to specific commits.

Copy link

changeset-bot bot commented Dec 15, 2024

⚠️ No Changeset found

Latest commit: ee9a60a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Dec 15, 2024

Walkthrough

The pull request modifies three GitHub workflow files (.github/workflows/publish-backoffice.yml, .github/workflows/publish-kyb-app.yml, and .github/workflows/publish-workflows-dashboard.yml) to enhance Docker image tagging. The primary change involves adding the Git commit SHA as a new tag for both non-production and production Docker images. Additionally, the image scanning steps have been updated to reference images using the commit SHA, improving traceability and specificity during the build and scanning processes.

Changes

File Change Summary
.github/workflows/publish-backoffice.yml Added Git commit SHA as a tag for non-production and production Docker images; updated image reference in scanning step to use commit SHA
.github/workflows/publish-kyb-app.yml Added Git commit SHA as a tag for non-production and production Docker images; updated image scanning step to reference image by commit SHA
.github/workflows/publish-workflows-dashboard.yml Added Git commit SHA as a tag for non-production and production Docker images; updated image scanning step to use commit SHA

Sequence Diagram

sequenceDiagram
    participant Workflow
    participant DockerBuild
    participant ImageScanner
    
    Workflow->>DockerBuild: Build Docker image
    DockerBuild-->>Workflow: Generate image with commit SHA tag
    Workflow->>ImageScanner: Scan image using commit SHA
    ImageScanner-->>Workflow: Return scan results
Loading

Possibly related PRs

Suggested reviewers

  • MayurDuduka
  • alonp99
  • liorzam

Poem

🐰 Commit SHA, oh so bright,
Tagging images with pure delight,
Tracing builds with precision's might,
A rabbit's workflow, sleek and tight,
Docker's magic takes its flight! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. This feature will be included in our Pro Plan when released.


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.

CodeRabbit Configuration 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.

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

🔭 Outside diff range comments (1)
.github/workflows/publish-kyb-app.yml (1)

Line range hint 31-35: Remove duplicate Container registry login step

The workflow contains two identical "Log in to the Container registry" steps. The second one is redundant and can be removed.

-      - name: Log in to the Container registry
-        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}

Also applies to: 61-65

🧹 Nitpick comments (2)
.github/workflows/publish-workflows-dashboard.yml (1)

108-108: Fix spacing inconsistency in image-ref

There's an inconsistent spacing after github.sha compared to other workflow files.

-          image-ref: '${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.sha}}'
+          image-ref: '${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.sha }}'
.github/workflows/publish-kyb-app.yml (1)

115-115: Fix spacing inconsistency in image-ref

There's an inconsistent spacing after github.sha compared to the backoffice workflow.

-          image-ref: '${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.sha}}'
+          image-ref: '${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.sha }}'
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35e675e and ee9a60a.

📒 Files selected for processing (3)
  • .github/workflows/publish-backoffice.yml (3 hunks)
  • .github/workflows/publish-kyb-app.yml (3 hunks)
  • .github/workflows/publish-workflows-dashboard.yml (3 hunks)
🔇 Additional comments (1)
.github/workflows/publish-backoffice.yml (1)

67-68: LGTM! Improved image tagging and scanning stability

The changes enhance the Docker image management by:

  1. Adding SHA-based tags for both production and non-production builds
  2. Using commit SHA for image scanning instead of branch names, which provides a more stable and unique reference

This improvement helps avoid potential issues with special characters in branch names and ensures consistent image scanning.

Also applies to: 90-91, 109-109

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.

1 participant