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

Drop white blacklist pt1 #37816

Merged
merged 3 commits into from
Jul 13, 2020
Merged

Drop white blacklist pt1 #37816

merged 3 commits into from
Jul 13, 2020

Conversation

balloob
Copy link
Member

@balloob balloob commented Jul 13, 2020

Breaking change

The core configuration option whitelist_external_dirs has been deprecated. Use allowlist_external_dirs instead.

homeassistant:
  allowlist_external_dirs:
    - /home/paulus/party

Proposed change

This is a first set of changes updating our code to drop references to white/blacklist. This changes the core config option whitelist_external_dirs and renames it to allowlist_external_dirs.

For now we will still accept the old config key and also still include it in the returned config from API responses.

Frontend PR: home-assistant/frontend#6372
Websocket PR: home-assistant/home-assistant-js-websocket#128
Docs PR: home-assistant/home-assistant.io#13992

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

Comment on lines +514 to +515
CONF_ALLOWLIST_EXTERNAL_DIRS,
LEGACY_CONF_WHITELIST_EXTERNAL_DIRS,
Copy link
Contributor

Choose a reason for hiding this comment

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

These values are swapped around:

2020-07-16 08:43:42 WARNING (MainThread) [homeassistant.config] Key allowlist_external_dirs has been replaced with whitelist_external_dirs. Please update your config

Copy link
Member

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants