Skip to content

Document rebuilding addons with force #2718

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 2 commits into
base: master
Choose a base branch
from
Open

Document rebuilding addons with force #2718

wants to merge 2 commits into from

Conversation

felipecrs
Copy link
Contributor

@felipecrs felipecrs commented Jul 7, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Documents the force option for the addons/<addons>/rebuild endpoint in the Supervisor API, which allows users to force a rebuild of an add-on even if it has an image set in its config.yaml.

This is useful for testing changes to the add-on, avoiding the need for commenting out the image line in the config.yml file.

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features for which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Remove stale or deprecated documentation

Checklist

  • I have read and followed the documentation guidelines.
  • I have verified that my changes render correctly in the documentation.

Additional information

/cc @agners

Summary by CodeRabbit

Summary by CodeRabbit

  • Documentation
    • Updated the API documentation for the /addons/<addon>/rebuild endpoint to include a description of the new optional force parameter in the POST request payload.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 7, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The documentation for the /addons/<addon>/rebuild API endpoint was updated to include information about a new optional boolean payload parameter, force, which enables forced rebuilding of an add-on even when an image is specified in its configuration. No code or control flow changes were made.

Changes

File(s) Change Summary
docs/api/supervisor/endpoints.md Updated documentation for /addons/<addon>/rebuild endpoint to describe the new force option in the POST payload.

Sequence Diagram(s)

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

📜 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 e541c3c and 6e50f55.

📒 Files selected for processing (1)
  • docs/api/supervisor/endpoints.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/api/supervisor/endpoints.md

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 Jul 7, 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)
docs/api/supervisor/endpoints.md (1)

373-375: Consider specifying the default & version-gate

Readers may wonder what happens when force is omitted and from which Supervisor version the flag is supported. Adding something like “Defaults to false; available since Supervisor ≥ 2024.06” would remove any ambiguity.

-| force | boolean | True     | Force rebuild the add-on, even if it has `image` set in its `config.yaml` |
+| force | boolean | True     | Force rebuild the add-on, even if it has `image` set in its `config.yaml` (default: `false`, Supervisor ≥ 2024.06) |
📜 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 8de9ba5 and e541c3c.

📒 Files selected for processing (1)
  • docs/api/supervisor/endpoints.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - developers-home-assistant
  • GitHub Check: Header rules - developers-home-assistant
  • GitHub Check: Pages changed - developers-home-assistant
🔇 Additional comments (1)
docs/api/supervisor/endpoints.md (1)

370-376: Payload table looks correct 👍

Column order, casing (boolean), and “optional” flag match surrounding sections. No further action needed.

@felipecrs felipecrs mentioned this pull request Jul 7, 2025
Merged
14 tasks
@felipecrs
Copy link
Contributor Author

felipecrs commented Jul 17, 2025 •
edited
Loading

@agners maybe it's a good time to merge this PR now that a new version of Supervisor was released with the change.

There's home-assistant-libs/python-supervisor-client#133 too.

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

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@felipecrs
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy