8000 Add upload file action to immich integration by mib1185 · Pull Request #39668 · home-assistant/home-assistant.io · GitHub
[go: up one dir, main page]
Skip to content

Add upload file action to immich integration #39668

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
Open
wants to merge 4 commits into
base: next
Choose a base branch
from
Open

Add upload file action to immich integration #39668

wants to merge 4 commits into from

Conversation

mib1185
Copy link
Contributor
@mib1185 mib1185 commented Jun 22, 2025 •
edited by coderabbitai bot
Loading

Proposed change

This adds a description for the new upload file action.

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

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
    • Added a new "Actions" section to the Immich integration documentation, detailing the "Upload file" action for uploading media files to an Immich instance, with usage instructions and an example script.

@Copilot Copilot AI review requested due to automatic review settings June 22, 2025 12:07
@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Jun 22, 2025
@netlify Netlify
Copy link
netlify bot commented Jun 22, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit b4761bc
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6859034ab6bd620008d81257
😎 Deploy Preview https://deploy-preview-39668--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.

@mib1185 mib1185 mentioned this pull request Jun 22, 2025
Open
22 tasks
Copilot
Copilot AI reviewed Jun 22, 2025
View reviewed changes
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 pull request adds documentation for a new upload file action to the Immich integration, explaining its purpose and usage.

  • Added a new "Actions" section with an "Upload file" action.
  • Included an argument table and an example script demonstrating how to use the new upload file action.

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Jun 22, 2025 •
edited
Loading
📝 Walkthrough

Walkthrough

A new "Actions" section has been added to the Immich integration documentation, detailing an "Upload file" action. This section explains the required arguments and provides an example script for uploading media files, including camera snapshots, to an Immich instance or album.

Changes

File Change Summary
source/_integrations/immich.markdown Added documentation for the new "Upload file" action, including usage details and an example script.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant ImmichInstance

    User->>HomeAssistant: Trigger "Upload file" action with file path and album ID
    HomeAssistant->>ImmichInstance: Upload media file (with optional album ID)
    ImmichInstance-->>HomeAssistant: Confirm upload
    HomeAssistant-->>User: Action result/confirmation
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 0a7e2cf and b4761bc.

📒 Files selected for processing (1)
  • source/_integrations/immich.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/immich.markdown

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.

coderabbitai[bot]
coderabbitai bot reviewed Jun 22, 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: 1

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

71-71: Consistent capitalization for “Album ID”
Use “ID” in uppercase to match common HA docs style.

-| Album id | `album_id` | no | ...
+| Album ID | `album_id` | no | ...
📜 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 95d3513 and 2b60b8c.

📒 Files selected for processing (1)
  • source/_integrations/immich.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/immich.markdown (1)

61-64: Placement of the new “Actions” section is correct
The “Actions” heading and its level align with Home Assistant docs conventions and follow the existing flow.

@mib1185 @Copilot
Apply suggestions from code review
b547bd9 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
mib1185
mib1185 commented Jun 22, 2025
View reviewed changes
mib1185
mib1185 commented Jun 22, 2025
View reviewed changes
c0ffeeca7
c0ffeeca7 previously approved these changes Jun 23, 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, @mib1185 👍

@c0ffeeca7
Copy link
Contributor

A merge conflict appeared. Could you take a look, @mib1185 ?

@c0ffeeca7 c0ffeeca7 marked this pull request as draft June 23, 2025 06:39
@c0ffeeca7 c0ffeeca7 marked this pull request as ready for review June 23, 2025 07:43
@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Jun 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

Copilot code review Copilot Copilot left review comments

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees
No one assigned
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mib1185 @c0ffeeca7
0