Add issue to repairs for removed Steam YAML configuration (#75737)

This commit is contained in:
Franck Nijhof 2022-07-26 01:11:07 +02:00 committed by GitHub
parent c7ddc595ed
commit 4ea532b3ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 31 additions and 0 deletions

View File

@ -1,11 +1,13 @@
"""The Steam integration."""
from __future__ import annotations
from homeassistant.components.repairs import IssueSeverity, async_create_issue
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import Platform
from homeassistant.core import HomeAssistant
from homeassistant.helpers.device_registry import DeviceEntryType
from homeassistant.helpers.entity import DeviceInfo
from homeassistant.helpers.typing import ConfigType
from homeassistant.helpers.update_coordinator import CoordinatorEntity
from .const import DEFAULT_NAME, DOMAIN
@ -14,6 +16,22 @@ from .coordinator import SteamDataUpdateCoordinator
PLATFORMS = [Platform.SENSOR]
async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
"""Set up the Steam integration."""
if DOMAIN in config:
async_create_issue(
hass,
DOMAIN,
"removed_yaml",
breaks_in_ha_version="2022.8.0",
is_fixable=False,
severity=IssueSeverity.WARNING,
translation_key="removed_yaml",
)
return True
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
"""Set up Steam from a config entry."""
coordinator = SteamDataUpdateCoordinator(hass)

View File

@ -4,6 +4,7 @@
"config_flow": true,
"documentation": "https://www.home-assistant.io/integrations/steam_online",
"requirements": ["steamodd==4.21"],
"dependencies": ["repairs"],
"codeowners": ["@tkdrob"],
"iot_class": "cloud_polling",
"loggers": ["steam"]

View File

@ -35,5 +35,11 @@
"error": {
"unauthorized": "Friends list restricted: Please refer to the documentation on how to see all other friends"
}
},
"issues": {
"removed_yaml": {
"title": "The Steam YAML configuration has been removed",
"description": "Configuring Steam using YAML has been removed.\n\nYour existing YAML configuration is not used by Home Assistant.\n\nRemove the YAML configuration from your configuration.yaml file and restart Home Assistant to fix this issue."
}
}
}

View File

@ -24,6 +24,12 @@
}
}
},
"issues": {
"removed_yaml": {
"description": "Configuring Steam using YAML has been removed.\n\nYour existing YAML configuration is not used by Home Assistant.\n\nRemove the YAML configuration from your configuration.yaml file and restart Home Assistant to fix this issue.",
"title": "The Steam YAML configuration has been removed"
}
},
"options": {
"error": {
"unauthorized": "Friends list restricted: Please refer to the documentation on how to see all other friends"