Add body with update information to frontend update PRs #5691
Conversation
Overwrite the default body with useful version update information and a link to the new release. Also rename the title and use lower caps for local shell variables.
agners
changed the title
📝 WalkthroughWalkthroughThe workflow file Changes
Sequence Diagram(s)sequenceDiagram
participant WF as Workflow
participant FS as File System
participant GH as GitHub PR Process
WF->>FS: Read .ha-frontend-version file to set current_version
FS-->>WF: Return current_version
WF->>WF: Retrieve latest_version from external step
WF->>WF: Compare current_version with latest_version
alt Version matches
WF-->>GH: No PR creation triggered
else Version mismatched
WF->>GH: Download release assets using latest_version
WF->>GH: Create pull request with updated version (commit, title, body)
end
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/workflows/update_frontend.yml (2)
13-14: Standardize Workflow Output Variable Names
The new outputs forcurrent_versionandlatest_versionimprove clarity and consistency. However, note thatlatest_versionis still derived from an output namedlatest_tagin thelatest_frontend_versionstep. Please verify that this is intentional and that the naming aligns with your cross-step variable usage.
27-31: Verify Version Comparison Logic
In the "Check if version is up to date" step, the script reads the current version and then uses the condition:if [[ ! "$current_version" < "$latest_version" ]]; thenThis relies on lexicographical string comparison. Be sure that your version format (for example, semantic versions) works correctly with this operator. If not, consider adopting a more robust version comparison strategy (e.g., using sorting tools or dedicated semantic version comparison utilities).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/update_frontend.yml(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Build armv7 supervisor
- GitHub Check: Build armhf supervisor
- GitHub Check: Build aarch64 supervisor
- GitHub Check: Run tests Python 3.13.2
🔇 Additional comments (6)
.github/workflows/update_frontend.yml (6)
41-41: Align PR Search String with New Naming Standard
The search string has been updated to"Update frontend to version $LATEST_VERSION", which aligns with the new naming convention in the commit message and PR title. This should help avoid duplicates and ensure consistency in PR detection.
58-58: Consistent Version File Update
Updating.ha-frontend-versionwithlatest_versionensures that the local version file reflects the expected value. This change is clear and maintains consistency across the workflow.
63-64: Update Release Asset Download Configuration
The modifications in the "Download release assets" step—updating both thetagandfileNameto referencelatest_version—ensure that the correct release asset is downloaded. This change is consistent with the new naming strategy.
70-70: Dynamic Commit Message Update
The commit message now dynamically reflects the latest version with:commit-message: "Update frontend to version ${{ needs.check-version.outputs.latest_version }}"This improvement aids in traceability and aligns with the version-based update process.
75-75: Consistent PR Title
Changing the PR title to uselatest_versionenhances consistency across the workflow configuration and makes it clear which version is being updated.
76-80: Enhanced PR Body Description
The new PR body clearly documents the version change by detailing the update—from the current version to the new version and including a link to the release. This helps reviewers and stakeholders understand the changes at a glance.
Proposed change
Overwrite the default body with useful version update information and a link to the new release.
Also rename the title and use lower caps for local shell variables.
Type of change
Additional information
Checklist
ruff format supervisor tests)If API endpoints or add-on configuration are added/changed:
Summary by CodeRabbit