Skip to content

Deprecate legacy "homeassistant" entry in hassio backup/restore folders#170317

Merged
MartinHjelmare merged 1 commit into
devfrom
feature/hassio-legacy-folder-deprecation
May 13, 2026
Merged

Deprecate legacy "homeassistant" entry in hassio backup/restore folders#170317
MartinHjelmare merged 1 commit into
devfrom
feature/hassio-legacy-folder-deprecation

Conversation

@agners
Copy link
Copy Markdown
Member

@agners agners commented May 11, 2026

Breaking change

Proposed change

Follow-up of #170312.

The hassio.backup_partial and hassio.restore_partial actions still accept "homeassistant" inside the folders list as a legacy alias for setting homeassistant: true. Raise a fixable, persistent repair issue when the alias is used so users can migrate their automations and scripts. The alias is scheduled to be removed in 2026.12.

The repair flow uses ConfirmRepairFlow, so users mark the issue resolved themselves once they've updated their automations.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • I understand the code I am submitting and can explain how it works.
  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

The hassio.backup_partial and hassio.restore_partial actions still
accept "homeassistant" inside the folders list as an alias for setting
homeassistant=True. Raise a fixable, persistent repair issue when the
legacy alias is used so users can migrate their automations and
scripts. The alias is scheduled to be removed in 2026.12.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 11, 2026 10:30
@agners agners added integration: hassio deprecation Indicates a breaking change to happen in the future labels May 11, 2026
@home-assistant
Copy link
Copy Markdown
Contributor

Hey there @home-assistant/supervisor, mind taking a look at this pull request as it has been labeled with an integration (hassio) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of hassio can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign hassio Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Copy link
Copy Markdown
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

Adds a persistent, fixable Repairs issue to help users migrate off the legacy "homeassistant" entry in the folders list for hassio.backup_partial / hassio.restore_partial, ahead of its planned removal in 2026.12.

Changes:

  • Create a persistent warning Repairs issue when the legacy "homeassistant" folder alias is used in partial backup/restore.
  • Add a ConfirmRepairFlow fix flow and corresponding user-facing translations for the new issue.
  • Extend the existing hassio partial backup legacy-folder test to assert the issue is created.

Reviewed changes

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

Show a summary per file
File Description
tests/components/hassio/test_init.py Verifies a Repairs issue is created when the legacy folder alias is used.
homeassistant/components/hassio/strings.json Adds translations for the new persistent, fixable Repairs issue and confirm flow.
homeassistant/components/hassio/services.py Raises the Repairs issue from the legacy-folder normalization path in partial backup/restore services.
homeassistant/components/hassio/repairs.py Routes the new issue to a ConfirmRepairFlow so users can self-resolve after updating automations/scripts.
homeassistant/components/hassio/const.py Defines the new issue key constant used across services/repairs/translations.

Copy link
Copy Markdown
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.

Thanks!

@MartinHjelmare MartinHjelmare merged commit d3b2be7 into dev May 13, 2026
89 of 90 checks passed
@MartinHjelmare MartinHjelmare deleted the feature/hassio-legacy-folder-deprecation branch May 13, 2026 10:35
@github-actions github-actions Bot locked and limited conversation to collaborators May 14, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants