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

Build docker image on PRs that touch the docker files #4374

Merged
merged 2 commits into from
Oct 23, 2024

Conversation

jesserockz
Copy link
Member

Description:

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable): esphome/esphome#

Checklist:

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • Link added in /index.rst when creating new documents for new components or cookbook.

Copy link

netlify bot commented Oct 23, 2024

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 6db6e1c
🔍 Latest deploy log https://app.netlify.com/sites/esphome/deploys/67188b1d54978300081eed80
😎 Deploy Preview https://deploy-preview-4374--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

Walkthrough

The pull request modifies the Docker workflow configuration in .github/workflows/docker.yml. It introduces a new trigger for pull_request events, activating the workflow when changes occur in specified files. Conditional logic is added to prevent Docker login actions and image pushes during pull requests. This ensures that certain steps only execute under specific event conditions, enhancing the workflow's control flow.

Changes

File Change Summary
.github/workflows/docker.yml - Added pull_request trigger for requirements.txt, Dockerfile, and .github/workflows/docker.yml.
- Introduced conditional statements for DockerHub and GitHub Container Registry login steps to execute only if the event is not a pull request.
- Updated push parameter to conditionally push the image based on whether the event is a pull request.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant Workflow
    participant DockerHub
    participant GCR

    User->>GitHub: Create Pull Request
    GitHub->>Workflow: Trigger Workflow
    Workflow->>DockerHub: Check if login needed
    alt Not a Pull Request
        Workflow->>DockerHub: Login
        Workflow->>GCR: Login
        Workflow->>DockerHub: Build and Push Image
    else Pull Request
        Workflow->>DockerHub: Skip Login
        Workflow->>GCR: Skip Login
        Workflow->>DockerHub: Skip Push
    end
Loading

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 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 and nitpick comments (1)
.github/workflows/docker.yml (1)

60-60: LGTM! Consider optimizing build cache configuration.

The conditional push configuration correctly prevents pushing images from PR builds.

Consider expanding the cache-from configuration to use both registries for better cache hit rates:

-          cache-from: ghcr.io/esphome/esphome-docs:latest
+          cache-from: |
+            ghcr.io/esphome/esphome-docs:latest
+            esphome/esphome-docs:latest
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between af23a23 and ec19deb.

📒 Files selected for processing (1)
  • .github/workflows/docker.yml (3 hunks)
🧰 Additional context used
🔇 Additional comments (3)
.github/workflows/docker.yml (3)

12-16: LGTM! Well-structured trigger configuration.

The pull request trigger is correctly configured with appropriate path filters that match the existing push trigger paths, ensuring consistent workflow execution.


42-42: LGTM! Good security practice.

Skipping DockerHub login during pull requests is a good security measure as it prevents potential exposure of credentials in PR builds.


48-48: LGTM! Consistent security implementation.

The condition matches the DockerHub login security measure, maintaining consistent security practices across different registries.

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

LGTM 👍

../Frenck

@frenck frenck merged commit e985371 into current Oct 23, 2024
4 checks passed
@frenck frenck deleted the jesserockz-2024-491 branch October 23, 2024 06:51
@jesserockz jesserockz mentioned this pull request Oct 23, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants