Document deprecation of advanced mode in apps#2982
Conversation
There was a problem hiding this comment.
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
advancedapp configuration option from the app configuration reference. - Update the Supervisor
/addons/<addon>/infoendpoint docs to mark theadvancedfield as deprecated/ignored (alwaysfalse).
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.
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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 configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated documentation: the supervisor API/model docs mark the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
docs/api/supervisor/endpoints.mddocs/apps/configuration.md
MartinHjelmare
left a comment
There was a problem hiding this comment.
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`. | |
There was a problem hiding this comment.
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 🤷
Proposed change
Advanced mode in apps is being deprecated. Remove documentation for the ignored configuration option and note deprecation status of the
advancedfield returned in addon info. Documention PR corresponding to home-assistant/supervisor#6614Type of change
Checklist
Additional information
Summary by CodeRabbit