Skip to content

Improve error message when people have not moved config flow title yet#34321

Merged
balloob merged 2 commits intodevfrom
improve-validation
Apr 17, 2020
Merged

Improve error message when people have not moved config flow title yet#34321
balloob merged 2 commits intodevfrom
improve-validation

Conversation

@balloob
Copy link
Copy Markdown
Member

@balloob balloob commented Apr 16, 2020

Breaking change

Proposed change

We want hassfest to be used by custom components. To do that, we need to make sure that we show helpful error messages when the integration format changes.

This captures a change we made to translations that custom components need to change: move title from config to root or delete it.

Example error message if found inside config:

Integration deconz:
* [TRANSLATIONS] Invalid strings.json: config.title key has been moved out of config and into the root of strings.json. Starting Home Assistant 0.109 you only need to define this key in the root if the title needs to be different than the name of your integration in the manifest. for dictionary value @ data['config']['title']. Got 'bla'

For custom integrations it's marked as a warning for now:

Integration deconz - homeassistant/components/deconz:
* [WARNING] [TRANSLATIONS] config.title key has been moved out of config and into the root of strings.json. Starting Home Assistant 0.109 you only need to define this key in the root if the title needs to be different than the name of your integration in the manifest.

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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
  • The code has been formatted using Black (black --fast 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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

@balloob balloob merged commit 2326a29 into dev Apr 17, 2020
@balloob balloob deleted the improve-validation branch April 17, 2020 01:00
@lock lock Bot locked and limited conversation to collaborators Apr 19, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla-signed new-feature small-pr PRs with less than 30 lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants