Skip to content

Commit

Permalink
Release v0.7.5 (#244)
Browse files Browse the repository at this point in the history
* Fixed missing widget name suffixes
([#243](#243)). In this
release, we have addressed an issue related to missing widget name
suffixes ([#243](#243)) by
adding a `_widget` suffix to the name of the widget object in the
dashboards.py file. This change ensures consistency between the widget
name and the id of the query, facilitating user understanding of the
relationship between the two. A new method, _get_query_widget_spec, has
also been added, although its specific functionality requires further
investigation. Additionally, the unit tests in the
`tests/unit/test_dashboards.py` file have been updated to check for the
presence of the `_widget` suffix in widget names, ensuring that the
tests accurately reflect the desired behavior. These changes improve the
consistency of dashboard widget naming, thus benefiting software
engineers utilizing or extending the project's widget-ordering
functionalities.
  • Loading branch information
nfx authored Jul 30, 2024
1 parent 9fb74ae commit df83fe2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Version changelog

## 0.7.5

* Fixed missing widget name suffixes ([#243](https://github.com/databrickslabs/lsql/issues/243)). In this release, we have addressed an issue related to missing widget name suffixes ([#243](https://github.com/databrickslabs/lsql/issues/243)) by adding a `_widget` suffix to the name of the widget object in the dashboards.py file. This change ensures consistency between the widget name and the id of the query, facilitating user understanding of the relationship between the two. A new method, _get_query_widget_spec, has also been added, although its specific functionality requires further investigation. Additionally, the unit tests in the `tests/unit/test_dashboards.py` file have been updated to check for the presence of the `_widget` suffix in widget names, ensuring that the tests accurately reflect the desired behavior. These changes improve the consistency of dashboard widget naming, thus benefiting software engineers utilizing or extending the project's widget-ordering functionalities.


## 0.7.4

* Fixed dataset/widget name uniqueness requirement that was preventing dashboards being deployed ([#241](https://github.com/databrickslabs/lsql/issues/241)). A fix has been implemented to address a uniqueness requirement issue with the dataset/widget name that was preventing dashboard deployment. A new `widget` instance is now created with a unique name, generated by appending `_widget` to the metadata ID, in the `get_layouts` method. This ensures that multiple widgets with the same ID but different content can exist in a single dashboard, thereby meeting the name uniqueness requirement. In the `save_to_folder` method, the widget name is modified by removing the `_widget` suffix before writing the textbox specification to a markdown file, maintaining consistency between the widget ID and file name. These changes are localized to the `get_layouts` and `save_to_folder` methods, and no new methods have been added. The existing functionality related to the creation, validation, and saving of dashboard layouts remains unaltered.
Expand Down
2 changes: 1 addition & 1 deletion src/databricks/labs/lsql/__about__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.7.4"
__version__ = "0.7.5"

0 comments on commit df83fe2

Please sign in to comment.