Skip to content

Lowercase SERVICE_ACCOUNT.json extension #37990

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 11, 2025
Merged

Lowercase SERVICE_ACCOUNT.json extension #37990

merged 1 commit into from
Apr 11, 2025

Conversation

tom-sherman
Copy link
Contributor

@tom-sherman tom-sherman commented Mar 15, 2025 •
edited by coderabbitai bot
Loading

Avoids confusion on systems where editing the file doesn't rename the extension (eg. windows file explorer). When downloading the file via GCP, the file is all lowercase and it's not natural to change the extension to uppercase.

Proposed change

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

  • Documentation
    • Refined the integration setup guide for Google Assistant, updating the file renaming instruction to use a lowercase file extension to ensure compatibility with case-sensitive systems.

@tom-sherman
Lowercase SERVICE_ACCOUNT.json extension
b9423d2 
Avoids confusion on systems where editing the file doesn't rename the extension (eg. windows file explorer). When downloading the file via GCP, the file is all lowercase and it's not natural to change the extension to uppercase.
@home-assistant home-assistant bot added the current This PR goes into the current branch label Mar 15, 2025
@netlify Netlify
Copy link

netlify bot commented Mar 15, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit b9423d2
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67d55449cef4f900089ef99d
😎 Deploy Preview https://deploy-preview-37990--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 site configuration.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 15, 2025

📝 Walkthrough

Walkthrough

This change updates the setup instructions for the Google Assistant integration. The pull request modifies the filename case used in the instruction to rename the downloaded JSON file from SERVICE_ACCOUNT.JSON to SERVICE_ACCOUNT.json. No code or functional alterations were introduced; the update solely affects the documentation provided to users.

Changes

File(s) Change Summary
source/_integrations/google_assistant.markdown Updated the filename in the JSON renaming instruction from SERVICE_ACCOUNT.JSON to SERVICE_ACCOUNT.json

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

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.
    • 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 generate docstrings to generate docstrings for 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.

coderabbitai[bot]
coderabbitai bot reviewed Mar 15, 2025
View reviewed changes
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

🧹 Nitpick comments (1)
source/_integrations/google_assistant.markdown (1)

160-164: YAML Configuration Consistency

The YAML configuration example still references the service account file as SERVICE_ACCOUNT.JSON (with an uppercase extension). To prevent confusion and ensure consistency with the updated renaming instruction, please update it to use the lowercase extension.

-  service_account: !include SERVICE_ACCOUNT.JSON
+  service_account: !include SERVICE_ACCOUNT.json
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c9aec73 and b9423d2.

📒 Files selected for processing (1)
  • source/_integrations/google_assistant.markdown (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/google_assistant.markdown (1)

79-80: File Rename Instruction Correctness

The instruction now correctly directs users to rename the downloaded file to SERVICE_ACCOUNT.json with a lowercase extension. This change aligns with the PR objective and the behavior observed from GCP downloads.

c0ffeeca7
c0ffeeca7 approved these changes Apr 11, 2025
View reviewed changes
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @tom-sherman 👍

@github-project-automation github-project-automation bot moved this from Todo to Approved in Documentation PRs Apr 11, 2025
@c0ffeeca7 c0ffeeca7 merged commit 9720d82 into home-assistant:current Apr 11, 2025
7 checks passed
@github-project-automation github-project-automation bot moved this from Approved to Done in Documentation PRs Apr 11, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees
No one assigned
Labels
current This PR goes into the current branch
Projects
No open projects
Documentation PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tom-sherman @c0ffeeca7