Skip to content

Show and archive generated proto-files if diff #1198

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

Merged
merged 2 commits into from
Jun 8, 2025
Merged

Conversation

dala318
Copy link
Contributor

@dala318 dala318 commented May 26, 2025

What does this implement/fix?

If there is a diff in generated Proto-files, show the diff and archive the generated files for download to work-area.
Mitigating having to set-up a type-like proto environment locally.
Example for failed run https://github.com/esphome/aioesphomeapi/actions/runs/15255852122/job/42903200847

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code quality improvements to existing code or addition of tests
  • Other

Related issue or feature (if applicable):

  • fixes

Pull request in esphome (if applicable):

  • esphome/esphome#

Checklist:

  • The code change is tested and works locally.
  • If api.proto was modified, a linked pull request has been made to esphome with the same changes.
  • Tests have been added to verify that the new code works (under tests/ folder).

Copy link

codecov bot commented May 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (59bcddc) to head (641992f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1198   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines         2900      2900           
=========================================
  Hits          2900      2900           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link

codspeed-hq bot commented May 26, 2025

CodSpeed Performance Report

Merging #1198 will not alter performance

Comparing dala318:ci_proto (641992f) with main (59bcddc)

Summary

✅ 11 untouched benchmarks

Copy link
Contributor

coderabbitai bot commented May 26, 2025

Walkthrough

The workflow configuration in .github/workflows/ci.yml has been updated to change the sequence and conditions for running tests, uploading coverage reports, and handling protobuf file generation. Debugging and artifact upload steps are now introduced after a protobuf check fails, with test and coverage steps moved to execute only in this failure scenario.

Changes

File(s) Change Summary
.github/workflows/ci.yml Modified CI workflow: removed unconditional test and coverage steps for a specific matrix, added steps to show git diff, upload protobuf artifacts, and rerun tests and coverage only after protobuf check fails. Other steps remain unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant GitHub Actions
    participant Runner
    participant Codecov

    GitHub Actions->>Runner: Start CI workflow
    Runner->>Runner: Setup, lint, type check, benchmark
    alt Protobuf check passes
        Runner->>Runner: Continue workflow (no special action)
    else Protobuf check fails (specific matrix)
        Runner->>Runner: Show git diff
        Runner->>Runner: Upload protobuf artifacts
        Runner->>Runner: Run pytest with coverage
        Runner->>Codecov: Upload coverage report
    end
Loading

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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: 1

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

130-135: Fix typo in artifact name
The artifact is named "genrated-proto-files", which contains a typo. Rename it to "generated-proto-files" to avoid confusion when downloading artifacts.
Apply this diff:

@@ lines 133-134
-          name: genrated-proto-files
+          name: generated-proto-files
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dc0b5ec and 037acf4.

📒 Files selected for processing (1)
  • .github/workflows/ci.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/ci.yml (1)

127-129: Show changes on diff detection
This step correctly invokes git diff when the protobuf check fails under the specified matrix combination, and the if: ${{ failure() && … }} guard ensures it only runs in that failure scenario.

@bdraco
Copy link
Member

bdraco commented Jun 8, 2025

Thanks @dala318

@bdraco bdraco merged commit 90d437c into esphome:main Jun 8, 2025
19 checks passed
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