Skip to content

Update Rakefile #39846

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
Jul 4, 2025
Merged

Update Rakefile #39846

merged 2 commits into from
Jul 4, 2025

Conversation

mrdarrengriffin
Copy link
Contributor

@mrdarrengriffin mrdarrengriffin commented Jul 4, 2025

Proposed change

Fixes language scores task not firing

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Chores
    • Automated downloading and refreshing of supported language scores data to ensure up-to-date information is always available during site generation and preview.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Jul 4, 2025
Copy link

netlify bot commented Jul 4, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 970bd54
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6867fc66369e390008b65824
😎 Deploy Preview https://deploy-preview-39846--home-assistant-docs.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 project configuration.

@mrdarrengriffin mrdarrengriffin marked this pull request as ready for review July 4, 2025 16:06
@Copilot Copilot AI review requested due to automatic review settings July 4, 2025 16:06
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR ensures the language_scores_data task runs as part of both the :generate and :preview workflows.

  • Adds rake language_scores_data and failure handling to the :generate task.
  • Inserts rake language_scores_data into the :preview/:listen task.

Rakefile Outdated
Comment on lines 33 to 34
success = system "rake language_scores_data"
abort("Generating language scores failed") unless success
Copy link
Preview

Copilot AI Jul 4, 2025

Choose a reason for hiding this comment

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

[nitpick] Consider invoking the language_scores_data task in-process (e.g., Rake::Task['language_scores_data'].invoke) instead of shelling out to rake, to improve performance and avoid spawning a new Ruby process.

Suggested change
success = system "rake language_scores_data"
abort("Generating language scores failed") unless success
begin
Rake::Task['language_scores_data'].invoke
rescue => e
abort("Generating language scores failed: #{e.message}")
end

Copilot uses AI. Check for mistakes.

@@ -67,6 +69,7 @@ task :preview, :listen do |t, args|
system "compass compile --css-dir #{source_dir}/stylesheets" unless File.exist?("#{source_dir}/stylesheets/screen.css")
system "rake analytics_data"
system "rake version_data"
system "rake language_scores_data"
Copy link
Preview

Copilot AI Jul 4, 2025

Choose a reason for hiding this comment

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

The preview task doesn’t check the return value of language_scores_data, so failures will be silent. You may want to mirror the :generate task’s failure handling (e.g., abort on failure) to notify on errors.

Suggested change
system "rake language_scores_data"
success = system "rake language_scores_data"
abort("Generating language scores failed") unless success

Copilot uses AI. Check for mistakes.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

coderabbitai bot commented Jul 4, 2025

📝 Walkthrough

Walkthrough

The Rakefile was updated to introduce a new language_scores_data task that downloads language score data from a specified URL and saves it locally. This task is now integrated into the generate, preview, and initial compilation steps to ensure the data is always refreshed during these processes.

Changes

File(s) Change Summary
Rakefile Added language_scores_data task to fetch and store language scores JSON; integrated this task into related task sequences.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Rakefile
    participant RemoteServer as ohf-voice.github.io
    participant LocalFS as Local File System

    User->>Rakefile: Invoke generate/preview/compile task
    Rakefile->>RemoteServer: Request language_scores.json
    RemoteServer-->>Rakefile: Respond with JSON data
    Rakefile->>LocalFS: Write data to _data/language_scores.json
    Rakefile->>Rakefile: Continue with analytics, alerts, and version data tasks
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 18f7cdf and 970bd54.

📒 Files selected for processing (1)
  • Rakefile (2 hunks)
🔇 Additional comments (2)
Rakefile (2)

33-34: LGTM! Proper error handling implemented.

The language scores data task is correctly integrated into the generate task with proper error handling that matches the pattern used by other data tasks.


120-129: LGTM! Task implementation follows established pattern.

The new language_scores_data task correctly follows the same pattern as other data download tasks (analytics_data, alerts_data, version_data) and properly handles JSON downloading and file writing.


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 or @coderabbitai title 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.

@mrdarrengriffin mrdarrengriffin merged commit 029103d into current Jul 4, 2025
9 checks passed
@mrdarrengriffin mrdarrengriffin deleted the voice-language-scores-datafile-fix branch July 4, 2025 16:13
thecode pushed a commit that referenced this pull request Jul 4, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions github-actions bot locked and limited conversation to collaborators Jul 5, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants