Skip to content
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.

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

Support backup of add-ons with hyphens #115274

Merged
merged 3 commits into from
Apr 12, 2024
Merged

Conversation

agners
Copy link
Member

@agners agners commented Apr 9, 2024

Breaking change

Proposed change

The Supervisor allows add-ons to use hyphens in their slug. This change allows backup and restore service calls to use add-on names with hyphens. Use the existing regex validator to validate add-on slugs.

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

  • 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.

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 link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature. The key has expired.
agners Stefan Agner
The Supervisor allows add-ons to use hyphens in their slug. Allows
backup and restore service calls to use add-on names with hyphens.
As there is no simple way to check slugs with hyphens, simply
use string validation instead.

Fixes: #107693
@home-assistant
Copy link

home-assistant bot commented Apr 9, 2024

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 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 add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@home-assistant home-assistant bot added cla-signed core small-pr PRs with less than 30 lines. labels Apr 9, 2024
@agners agners changed the title Support add-ons with hyphens Support backup of add-ons with hyphens Apr 9, 2024
@BenoitAnastay
Copy link

The slugify function do use _ as separator (https://github.com/home-assistant/core/blob/dev/homeassistant/util/__init__.py#L44-L49) and we must keep that working the same.

So we can either state in all documentation and in config validation that slug must be separated by _
Or we also can replace - by _ in the validator before the comparaison

The validation of SLUG for supervisor is a regex where hyphen is allowed https://github.com/home-assistant/supervisor/blob/501c9579fb87f036c363fd70f0acfe3b70899ecd/supervisor/addons/const.py#L48

Verified

This commit was signed with the committer’s verified signature. The key has expired.
agners Stefan Agner

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@bdraco
Copy link
Member

bdraco commented Apr 11, 2024

codecov should be fixed now

@bdraco
Copy link
Member

bdraco commented Apr 11, 2024

influx db test failure is a flakey test. I attempted to fix it in #115442

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @agners 👍

../Frenck

@frenck frenck merged commit 35d3f2b into dev Apr 12, 2024
38 checks passed
@frenck frenck deleted the support-hyphens-in-add-on-names branch April 12, 2024 07:02
@frenck frenck added this to the 2024.4.3 milestone Apr 12, 2024
frenck pushed a commit that referenced this pull request Apr 12, 2024

Verified

This commit was signed with the committer’s verified signature. The key has expired.
frenck Franck Nijhof
Co-authored-by: J. Nick Koston <nick@koston.org>
@frenck frenck mentioned this pull request Apr 12, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Apr 13, 2024
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.

Create Partial Backup service call not working properly with slug names that have hyphen
4 participants