Skip to content

Rename S3 integration also in the release blog #38908

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 1 commit into from
May 6, 2025
Merged

Conversation

edenhaus
Copy link
Member

@edenhaus edenhaus commented May 6, 2025

Proposed change

Follow up for #38904

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
    • Updated release notes to rename the "S3" integration to "AWS S3."
    • Clarified that the integration is specifically for Amazon S3 storage buckets.
    • Updated references and links to reflect the new name.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch rc This PR is against the RC branch labels May 6, 2025
@home-assistant
Copy link

home-assistant bot commented May 6, 2025

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

@edenhaus edenhaus changed the title 2025.5: Beta release notes (#38827) Rename S3 integration also in the release blog May 6, 2025
Copy link

netlify bot commented May 6, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 703e26c
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6819f61f3cda9700080e0706
😎 Deploy Preview https://deploy-preview-38908--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.

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, @edenhaus 👍

@edenhaus
Copy link
Member Author

edenhaus commented May 6, 2025

Release blog post is not part of the next branch and therefore missed on the first rename

Copy link
Contributor

coderabbitai bot commented May 6, 2025

📝 Walkthrough

Walkthrough

The release notes markdown file was updated to rename the integration from "S3" to "AWS S3." The description now specifies support exclusively for Amazon S3 storage buckets, removing references to generic S3-compatible providers. All related references and links were updated to reflect the new naming.

Changes

File(s) Change Summary
source/_posts/2025-05-07-release-20255.markdown Renamed "S3" integration to "AWS S3" and updated description to specify Amazon S3 only; adjusted related references and links accordingly.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.


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.

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.

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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d00304f and 703e26c.

📒 Files selected for processing (1)
  • source/_posts/2025-05-07-release-20255.markdown (2 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/_posts/2025-05-07-release-20255.markdown (1)

284-285: Confirm rename and description update for the integration
The change correctly renames the “S3” integration to “AWS S3” and updates its description to explicitly reference Amazon S3 storage buckets. This aligns with our new naming convention and removes ambiguity around other S3-compatible providers.

@@ -300,7 +299,7 @@ To process:
[Miele]: /integrations/miele
[ntfy.sh]: https://ntfy.sh/
[ntfy]: /integrations/ntfy
[S3]: /integrations/s3
[AWS S3]: /integrations/aws_s3
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Verify that the AWS S3 integration docs exist at the new path
Please confirm that /integrations/aws_s3 is the correct slug and that the corresponding documentation file is present.

Run the following script to verify the existence of the integration doc:


🏁 Script executed:

#!/bin/bash
# Description: Check for AWS S3 integration documentation under docs/integrations
fd aws_s3 docs/integrations

Length of output: 134


🏁 Script executed:

#!/bin/bash
# Locate any 'integrations' directories
fd -t d integrations

# Find files or directories matching 'aws_s3*'
fd aws_s3*

# Search throughout the repo for references to 'aws_s3'
rg -n 'aws_s3' .

Length of output: 432


🏁 Script executed:

#!/bin/bash
# Search for AWS S3 integration docs under source/integrations and source/_integrations
echo "Files under source/integrations matching 'aws' or 's3':"
fd -t f -i 'aws' source/integrations || true
fd -t f -i 's3' source/integrations || true

echo
echo "Files under source/_integrations matching 'aws' or 's3':"
fd -t f -i 'aws' source/_integrations || true
fd -t f -i 's3' source/_integrations || true

echo
echo "Ripgrep for 'S3' in both directories:"
rg -n 'S3' source/integrations source/_integrations || true

Length of output: 4356


Correct AWS S3 integration link
The current slug /integrations/aws_s3 does not map to any docs. The S3 integration lives in source/_integrations/s3.markdown, which generates the /integrations/s3 slug. Please update line 302 in source/_posts/2025-05-07-release-20255.markdown:

-[AWS S3]: /integrations/aws_s3
+[AWS S3]: /integrations/s3
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
[AWS S3]: /integrations/aws_s3
[AWS S3]: /integrations/s3

@frenck frenck merged commit cebe951 into rc May 6, 2025
9 checks passed
@frenck frenck deleted the edenhaus-s3-rename-blog branch May 6, 2025 11:55
@home-assistant home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on labels May 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rc This PR is against the RC branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants