Update Docs for App-Specific Passwords #33510

rcmaehl · 2024-07-01T16:23:51Z

See:
home-assistant/core#101816
home-assistant/core#120945

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).
- I've opened up a PR to add logos and icons in Brands repository.
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 iCloud integration instructions to clarify potential for recurring notifications if improperly configured, instructing users to select "Don't Allow" and reconfigure credentials if needed.
- Emphasized the necessity of using App-Specific Passwords for setting up the integration to enhance security and prevent recurring MFA prompts.

home-assistant · 2024-07-01T16:23:55Z

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.

coderabbitai · 2024-07-01T16:23:57Z

Walkthrough

The updates to the icloud.markdown file in the Home Assistant documentation include clarifications on handling recurring notifications from Apple if the iCloud integration is improperly configured. It emphasizes the importance of using App-Specific Passwords for two-factor authentication to avoid recurring MFA prompts, thereby enhancing user guidance on security and troubleshooting.

Changes

File Path	Change Summary
`source/_integrations/icloud.markdown`	- Notification Update: Clarified that recurring emails and notifications occur if integration is improperly configured, with instructions to select "Don't Allow" and reconfigure. - Two Factor Authentication Update: Emphasized the necessity of using App-Specific Passwords to prevent recurring prompts.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Home Assistant
    participant Apple iCloud

    User->>Home Assistant: Setup iCloud Integration
    Home Assistant->>Apple iCloud: Request Authentication
    Apple iCloud->>User: Send MFA Prompt

    alt Using Account Password
        User->>Apple iCloud: Send MFA Code
        Apple iCloud->>User: Frequent MFA Prompts
    else Using App-Specific Password
        Apple iCloud->>User: No Frequent MFA Prompts
    end
    
    Note over User,Home Assistant: If improperly configured, recurring notifications from Apple

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a5c07ca and 496e103.

Files selected for processing (1)

source/_integrations/icloud.markdown (2 hunks)

Additional comments not posted (2)

source/_integrations/icloud.markdown (2)

32-35: LGTM! The warning message is clear and correctly formatted.

The updated warning message is clear and provides actionable steps for users.

41-43: LGTM! The important note is clear and correctly formatted.

The added note emphasizes the necessity of using an app-specific password and is clearly written.

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?

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

netlify · 2024-07-01T16:24:07Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`496e103`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/669a240d87960c000892cacb
😎 Deploy Preview	https://deploy-preview-33510--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle 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

Actionable comments posted: 2

source/_integrations/icloud.markdown

coderabbitai

Actionable comments posted: 1

source/_integrations/icloud.markdown

rcmaehl · 2024-07-01T16:36:32Z

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.

This should not be required as it can apply to the existing configuration without issue. I have updated the title to reflect this.

source/_integrations/icloud.markdown

frenck · 2024-07-01T17:10:39Z

source/_integrations/icloud.markdown

@@ -29,7 +29,7 @@ It does require that your devices are registered with the [Find My](https://www.
 {% include integrations/config_flow.md %}

 {% warning %}
-You may receive an email and a notification from Apple saying that someone has logged into your account.
+You may receive recurring emails and notifications from Apple stating that someone has logged into your account if the integration is improperly configured.


This doesn't help, as it tells the user they did something wrong without providing a solution.

Looking to see if I can figure out a method to update the credentials to App-specific Password for the Integration without removing and readding the Integration.

Worst case scenario, could we wait for the current auth period to expire?

I've updated this in 564a43c. Let me know if you'd like the wording changed/improved.

home-assistant · 2024-07-01T17:10:43Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

source/_integrations/icloud.markdown

frenck · 2024-07-06T09:13:25Z

@rcmaehl This PR looks pretty ready to go to me, but is still in draft. Are you still planning on making changes? Or did you forget to mark it ready for review maybe?

../Frenck

rcmaehl · 2024-07-07T02:04:32Z

@rcmaehl This PR looks pretty ready to go to me, but is still in draft. Are you still planning on making changes? Or did you forget to mark it ready for review maybe?

../Frenck

Yep. Forgot to mark!

coderabbitai

Actionable comments posted: 1

source/_integrations/icloud.markdown

coderabbitai

Actionable comments posted: 1

coderabbitai · 2024-07-07T03:43:29Z

source/_integrations/icloud.markdown

+{% important %}
+You need to use an [app-specific password](https://support.apple.com/102654) to set up this integration.
+{% endimportant %}


Hyphenate "Two-Factor Authentication".

When used as a modifier, "Two-Factor" should be hyphenated.

-## Two Factor Authentication +## Two-Factor Authentication

Committable suggestion was skipped due to low confidence.

Tools

LanguageTool

[misspelling] ~43-~43: Possible spelling mistake found.
Context: .../102654) to set up this integration. {% endimportant %} ## In case of troubleshooting Go i...

(MORFOLOGIK_RULE_EN_US)

See: home-assistant/core#101816 home-assistant/core#120945

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Co-authored-by: Franck Nijhof <[email protected]>

Co-authored-by: Rosemary Orchard <[email protected]>

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

c0ffeeca7

Thank you, @rcmaehl 👍

Comment has been addressed

rcmaehl requested a review from Quentame as a code owner July 1, 2024 16:23

home-assistant bot assigned rcmaehl Jul 1, 2024

home-assistant bot added current This PR goes into the current branch has-parent This PR has a parent PR in a other repo 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 labels Jul 1, 2024

coderabbitai bot reviewed Jul 1, 2024

View reviewed changes

source/_integrations/icloud.markdown Outdated Show resolved Hide resolved

source/_integrations/icloud.markdown Outdated Show resolved Hide resolved

coderabbitai bot reviewed Jul 1, 2024

View reviewed changes

source/_integrations/icloud.markdown Outdated Show resolved Hide resolved

rcmaehl changed the title ~~Update Docs for App-Specific Passwords (Requires home-assistant/core#120945)~~ Update Docs for App-Specific Passwords (REF: home-assistant/core#120945) Jul 1, 2024

frenck changed the title ~~Update Docs for App-Specific Passwords (REF: home-assistant/core#120945)~~ Update Docs for App-Specific Passwords Jul 1, 2024

frenck previously requested changes Jul 1, 2024

View reviewed changes

home-assistant bot marked this pull request as draft July 1, 2024 17:10

RosemaryOrchard reviewed Jul 2, 2024

View reviewed changes

source/_integrations/icloud.markdown Outdated Show resolved Hide resolved

rcmaehl marked this pull request as ready for review July 7, 2024 02:04

home-assistant bot requested a review from frenck July 7, 2024 02:04

coderabbitai bot reviewed Jul 7, 2024

View reviewed changes

source/_integrations/icloud.markdown Outdated Show resolved Hide resolved

coderabbitai bot reviewed Jul 7, 2024

View reviewed changes

frenck added the smash Indicator this PR is close to finish for merging or closing label Jul 19, 2024

rcmaehl and others added 5 commits July 19, 2024 10:30

Update Docs for App-Specific Passwords

12a3922

See: home-assistant/core#101816 home-assistant/core#120945

Update source/_integrations/icloud.markdown

1d91327

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

define "it" instead of using bot suggestion

64cde69

Update source/_integrations/icloud.markdown

d28c1e1

Co-authored-by: Franck Nijhof <[email protected]>

Update source/_integrations/icloud.markdown

1c7ebf7

Co-authored-by: Rosemary Orchard <[email protected]>

rcmaehl and others added 2 commits July 19, 2024 10:30

Advise on solution

4a63916

Update source/_integrations/icloud.markdown

496e103

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

frenck force-pushed the patch-1 branch from a5c07ca to 496e103 Compare July 19, 2024 08:30

c0ffeeca7 approved these changes Jul 19, 2024

View reviewed changes

c0ffeeca7 merged commit 03c7234 into home-assistant:current Jul 19, 2024
6 checks passed

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 Jul 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Docs for App-Specific Passwords #33510

Update Docs for App-Specific Passwords #33510

rcmaehl commented Jul 1, 2024 •

edited by coderabbitai bot

Loading

home-assistant bot commented Jul 1, 2024

coderabbitai bot commented Jul 1, 2024 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

netlify bot commented Jul 1, 2024 •

edited

Loading

coderabbitai bot left a comment

coderabbitai bot left a comment

rcmaehl commented Jul 1, 2024

frenck Jul 1, 2024

rcmaehl Jul 1, 2024

RosemaryOrchard Jul 2, 2024

rcmaehl Jul 6, 2024

home-assistant bot commented Jul 1, 2024

frenck commented Jul 6, 2024

rcmaehl commented Jul 7, 2024

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot Jul 7, 2024

c0ffeeca7 left a comment

Update Docs for App-Specific Passwords #33510

Update Docs for App-Specific Passwords #33510

Conversation

rcmaehl commented Jul 1, 2024 • edited by coderabbitai bot Loading

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

home-assistant bot commented Jul 1, 2024

coderabbitai bot commented Jul 1, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

netlify bot commented Jul 1, 2024 • edited Loading

✅ Deploy Preview for home-assistant-docs ready!

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

rcmaehl commented Jul 1, 2024

frenck Jul 1, 2024

Choose a reason for hiding this comment

rcmaehl Jul 1, 2024

Choose a reason for hiding this comment

RosemaryOrchard Jul 2, 2024

Choose a reason for hiding this comment

rcmaehl Jul 6, 2024

Choose a reason for hiding this comment

home-assistant bot commented Jul 1, 2024

frenck commented Jul 6, 2024

rcmaehl commented Jul 7, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Jul 7, 2024

Choose a reason for hiding this comment

c0ffeeca7 left a comment

Choose a reason for hiding this comment

rcmaehl commented Jul 1, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 1, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

netlify bot commented Jul 1, 2024 •

edited

Loading