Skip to content

v13.0.0

Choose a tag to compare

@github-actions github-actions released this 04 Mar 20:59

⚠️⚠️⚠️ BREAKING CHANGE! READ BEFORE UPDATE ⚠️⚠️⚠️

This release is a major one and it is a breaking change. This version needs Home Assistant 2026.3.0 as the minimum version to work. So, if you are not already in this version of Home Assistant DO NOT UPDATE.

Home Assistant 2026.3.0 has refactored many things that broke many functionalities of the plugin. The sidebar_editable option and all the methods to open dialogs got broken with this Home Assistant version. In these release all the issues have been solved.

Taking into account that this version is a breaking change, this release also introduces several breaking changes related to the name of the files. Pay special attention to the next changes.

1. Renaming of the configuration YAML file

The custom-sidebar configuration has been renamed from sidebar-config.yaml to custom-sidebar-config.yaml to keep consistency with the rest of the plugin files.

2. Renaming of the plugin JavaScript file

The plugin file has been renamed from custom-sidebar-yaml.js to custom-sidebar-plugin.js. You need to modify this in the frontend extra_module_url entry in your configuration.yaml:

  frontend:
    extra_module_url:
      - /hacsfiles/custom-sidebar/custom-sidebar-plugin.js

3. JSON bundle deprecation

Starting in this version, there is no a specific bundle and configuration file for JSON. When the project started, two bundles were created to support both approaches, the configuration in YAML from Villhellm and the configuration in JSON from galloween. From now on, a single bundle is provided. If you want to keep having a JSON configuration, you need to store it in the custom-sidebar-config.yaml file.

Summary of the changes

For users of the YAML bundle

  1. Rename your configuration inside the config/www/ folder from sidebar-config.yaml to custom-sidebar-config.yaml
  2. Rename the extra_module_url of the plugin in your configuration.yaml file:
  frontend:
    extra_module_url:
-     - /hacsfiles/custom-sidebar/custom-sidebar-yaml.js
+     - /hacsfiles/custom-sidebar/custom-sidebar-plugin.js

For users of the JSON bundle

  1. Rename your configuration inside the config/www/ folder from sidebar-config.json to custom-sidebar-config.yaml
  2. Rename the extra_module_url of the plugin in your configuration.yaml file:
  frontend:
    extra_module_url:
-     - /hacsfiles/custom-sidebar/custom-sidebar-json.js
+     - /hacsfiles/custom-sidebar/custom-sidebar-plugin.js

🛠 Fixes

🧩 Dependencies

  • [Dependencies]: Bump the dependencies-dev group with 4 updates
  • [Dependencies]: Bump the dependencies-dev group with 5 updates
  • Prepare the plugin for home assistant 2026.3.0

⚙️ Configuration

  • Remove preinstall script
  • [Github Actions]: Bump actions/upload-artifact from 6 to 7 in the actions-deps group

📝 Documentation