fix(hints): Handle merged hints.yml with the esp-idf v6.0#1419
Open
kolipakakondal wants to merge 4 commits intomasterfrom
Open
fix(hints): Handle merged hints.yml with the esp-idf v6.0#1419kolipakakondal wants to merge 4 commits intomasterfrom
kolipakakondal wants to merge 4 commits intomasterfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe PR refactors hints.yml file resolution to prioritize build-directory-relative files over legacy paths. It introduces Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (3)
.github/workflows/ci.yml (2)
108-108: Rename duplicate step names for clearer workflow logs.Both codesign steps are named "Codesign Espressif-IDE", which makes it difficult to distinguish them in CI logs. Consider using distinct names.
Suggested fix
- - name: Codesign Espressif-IDE + - name: Codesign Espressif-IDE app bundles uses: espressif/release-sign@master with: path: releng/com.espressif.idf.product/target/products/com.espressif.idf.product/macosx/cocoa- - name: Codesign Espressif-IDE + - name: Codesign Espressif-IDE DMGs uses: espressif/release-sign@master with: path: releng/ide-dmg-builderAlso applies to: 123-123
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/ci.yml at line 108, Two CI steps share the identical name "Codesign Espressif-IDE", making logs ambiguous; update the step names to unique, descriptive strings (e.g., "Codesign Espressif-IDE (macOS)" and "Codesign Espressif-IDE (Windows)" or include the target artifact) by locating both steps with the name "Codesign Espressif-IDE" in the workflow and editing their name fields so each step has a distinct, meaningful label.
109-109: Pinespressif/release-signto a specific commit SHA instead of@master.Using
@masteris risky for CI stability—changes to the action could unexpectedly fail builds. Since this action has no published releases, pin to a commit SHA for reproducibility and stability.Example fix
- uses: espressif/release-sign@master + uses: espressif/release-sign@<commit-sha>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/ci.yml at line 109, Replace the unstable uses reference "espressif/release-sign@master" with a pinned commit SHA to ensure CI reproducibility; locate a specific commit SHA from the espressif/release-sign repository and update the uses entry to "espressif/release-sign@<commit-sha>" (or a published tag if available), committing that change so the workflow references the immutable commit instead of `@master`.bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/dialogs/BuildView.java (1)
68-71: Consider usingisFile()instead ofexists()for consistency.The method
HintsUtil.resolveHintsYmlFile()usesisFile()to check file existence internally. Usingexists()here could returntrueeven ifhints.ymlwere a directory (unlikely but possible). Consider aligning with the internal check for consistency.♻️ Suggested change
File hintsYml = HintsUtil.resolveHintsYmlFile(IDFUtil.getActiveProjectBuildDirPath()); - if (!hintsYml.exists()) + if (!hintsYml.isFile()) {🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/dialogs/BuildView.java` around lines 68 - 71, Replace the boolean check on the resolved hintsYml File to use isFile() instead of exists() for consistency with HintsUtil.resolveHintsYmlFile(); locate the check in BuildView.java where hintsYml (from HintsUtil.resolveHintsYmlFile(IDFUtil.getActiveProjectBuildDirPath())) is tested and change the conditional that calls createNoHintsYmlLabel(hintsYml) so it uses hintsYml.isFile() (ensuring directories aren't treated as files).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In @.github/workflows/ci.yml:
- Line 108: Two CI steps share the identical name "Codesign Espressif-IDE",
making logs ambiguous; update the step names to unique, descriptive strings
(e.g., "Codesign Espressif-IDE (macOS)" and "Codesign Espressif-IDE (Windows)"
or include the target artifact) by locating both steps with the name "Codesign
Espressif-IDE" in the workflow and editing their name fields so each step has a
distinct, meaningful label.
- Line 109: Replace the unstable uses reference "espressif/release-sign@master"
with a pinned commit SHA to ensure CI reproducibility; locate a specific commit
SHA from the espressif/release-sign repository and update the uses entry to
"espressif/release-sign@<commit-sha>" (or a published tag if available),
committing that change so the workflow references the immutable commit instead
of `@master`.
In
`@bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/dialogs/BuildView.java`:
- Around line 68-71: Replace the boolean check on the resolved hintsYml File to
use isFile() instead of exists() for consistency with
HintsUtil.resolveHintsYmlFile(); locate the check in BuildView.java where
hintsYml (from
HintsUtil.resolveHintsYmlFile(IDFUtil.getActiveProjectBuildDirPath())) is tested
and change the conditional that calls createNoHintsYmlLabel(hintsYml) so it uses
hintsYml.isFile() (ensuring directories aren't treated as files).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 43f67084-1c5c-4d5b-b036-6811c486d405
📒 Files selected for processing (7)
.github/workflows/ci.ymlbundles/com.espressif.idf.core/src/com/espressif/idf/core/build/IDFBuildConfiguration.javabundles/com.espressif.idf.core/src/com/espressif/idf/core/util/HintsUtil.javabundles/com.espressif.idf.core/src/com/espressif/idf/core/util/IDFUtil.javabundles/com.espressif.idf.ui/src/com/espressif/idf/ui/dialogs/BuildView.javabundles/com.espressif.idf.ui/src/com/espressif/idf/ui/dialogs/HintsView.javatests/com.espressif.idf.core.test/src/com/espressif/idf/core/util/test/HintsUtilTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Please include a summary of the change and which issue is fixed.
Fixes # (IEP-XXX)
Type of change
Please delete options that are not relevant.
How has this been tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Test Configuration:
Dependent components impacted by this PR:
Checklist
Summary by CodeRabbit
New Features
Tests