Skip to content

Document deprecation of advanced mode in apps#2982

Open
mdegat01 wants to merge 3 commits intomasterfrom
deprecate-addon-advanced
Open

Document deprecation of advanced mode in apps#2982
mdegat01 wants to merge 3 commits intomasterfrom
deprecate-addon-advanced

Conversation

@mdegat01
Copy link
Contributor

@mdegat01 mdegat01 commented Mar 4, 2026

Proposed change

Advanced mode in apps is being deprecated. Remove documentation for the ignored configuration option and note deprecation status of the advanced field returned in addon info. Documention PR corresponding to home-assistant/supervisor#6614

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

Summary by CodeRabbit

  • Documentation
    • Deprecated the "advanced" configuration field; now always false as of v2026.03.0.
    • Removed the advanced mode configuration option from app settings.
    • Simplified the description of the stage option.
    • Added new configuration options: Docker init toggle, watchdog health-check URL, and a realtime schedule access flag.

Copy link
Contributor

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

Updates the developer documentation to reflect the deprecation of “advanced mode” behavior for apps (add-ons), removing the now-ignored config option and marking the related API field as deprecated.

Changes:

  • Remove the advanced app configuration option from the app configuration reference.
  • Update the Supervisor /addons/<addon>/info endpoint docs to mark the advanced field as deprecated/ignored (always false).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/apps/configuration.md Removes the deprecated/ignored advanced config option and trims related stage wording.
docs/api/supervisor/endpoints.md Updates the advanced field description in the add-on info endpoint to reflect deprecation/ignored behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 4, 2026

Warning

Rate limit exceeded

@mdegat01 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 56 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 91819162-b9cf-4206-bb3c-358889835b31

📥 Commits

Reviewing files that changed from the base of the PR and between 67aaede and 32f8ef2.

📒 Files selected for processing (1)
  • docs/apps/configuration.md
📝 Walkthrough

Walkthrough

Updated documentation: the supervisor API/model docs mark the advanced field as deprecated and always false; the apps configuration doc removes the advanced option, trims the stage description, and adds three new options: init, watchdog, and realtime.

Changes

Cohort / File(s) Summary
Supervisor API docs
docs/api/supervisor/endpoints.md, docs/api/supervisor/models.md
Marked the advanced field as deprecated/ignored and documented that it is always false (Supervisor 2026.03.0). Updated response example and public schema text accordingly.
Apps configuration docs
docs/apps/configuration.md
Removed the advanced: bool option; simplified stage description; added new options: init (Docker init toggle), watchdog (health-check URL), and realtime (schedule access flag). Reflowed surrounding option blocks.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Document deprecation of advanced mode in apps' clearly and concisely summarizes the main change: documenting the deprecation of advanced mode.
Description check ✅ Passed The description adequately addresses the template with a clear proposed change, appropriate type selection, and a link to the corresponding supervisor PR. However, both checklist items remain unchecked.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch deprecate-addon-advanced

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

Comment @coderabbitai help to get the list of available commands and usage tips.

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

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/apps/configuration.md`:
- Line 193: The markdown table row for the `stage` entry is missing the trailing
pipe which breaks MD055; update the row text that currently reads "`stage` |
string | `stable` | Flag app with follow attribute: `stable`, `experimental` or
`deprecated`." to include a trailing "|" at the end so it becomes a properly
terminated table row; locate the row by the `stage` column label in the table
and add the final pipe.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8544169f-d0a5-48b6-960f-64fd5b70a205

📥 Commits

Reviewing files that changed from the base of the PR and between 72070ed and f9d9895.

📒 Files selected for processing (2)
  • docs/api/supervisor/endpoints.md
  • docs/apps/configuration.md

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Should we add a dev blog post about the deprecation?

| `backup_exclude` | list | | List of files/paths (with glob support) that are excluded from backups.
| `advanced` | bool | `false` | Set this to `true` to require the user to have enabled "Advanced" mode for it to show.
| `stage` | string | `stable` | Flag app with follow attribute: `stable`, `experimental` or `deprecated`. Apps set to `experimental` or `deprecated` will not show up in the store unless the user enables advanced mode.
| `stage` | string | `stable` | Flag the app with one of the following attributes to give users an idea of its place in the development lifecycle: `stable`, `experimental` or `deprecated`. |
Copy link
Member

@agners agners Mar 9, 2026

Choose a reason for hiding this comment

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

Technically the frontend still uses the stage to hide apps in advanced mode 🤔

I created a separate task for the frontend team: home-assistant/frontend#30067.

I guess it's not a big deal if we already change the docs 🤷

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants