Skip to content

Commit

Permalink
Backport of "Update Release Notes for Taipy 4.0.1" (#1191) (#1196)
Browse files Browse the repository at this point in the history
  • Loading branch information
FabienLelaquais authored Nov 13, 2024
1 parent 8836db8 commit 32af514
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 30 deletions.
80 changes: 61 additions & 19 deletions docs/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,21 @@ This is the list of changes to Taipy releases as they were published.

Published on 2024-10.

[`taipy` 4.0](https://pypi.org/project/taipy/4.0.0/) depends on the latest
[`taipy-common` 4.0](https://pypi.org/project/taipy-common/4.0.0/),
[`taipy-gui` 4.0](https://pypi.org/project/taipy-gui/4.0.0/),
[`taipy-core` 4.0](https://pypi.org/project/taipy-core/4.0.0/),
[`taipy-templates` 4.0](https://pypi.org/project/taipy-templates/4.0.0/), and
[`taipy-rest` 4.0](https://pypi.org/project/taipy-rest/4.0.0/) packages.
[`taipy` 4.0](https://pypi.org/project/taipy/4.0.1/) depends on the latest
[`taipy-common` 4.0](https://pypi.org/project/taipy-common/4.0.1/),
[`taipy-gui` 4.0](https://pypi.org/project/taipy-gui/4.0.1/),
[`taipy-core` 4.0](https://pypi.org/project/taipy-core/4.0.1/),
[`taipy-templates` 4.0](https://pypi.org/project/taipy-templates/4.0.1/), and
[`taipy-rest` 4.0](https://pypi.org/project/taipy-rest/4.0.1/) packages.

## Known issues
!!! warning "Upgrading to Taipy 4.0 from 3.x"

<h4><strong><code>taipy-gui</code></strong> 4.0.0</h4>
Due to changes in Taipy’s package structure in version 4.0, the previous version of the
`taipy-config` package may not be automatically removed during the upgrade process. This could
lead to runtime issues as the system may attempt to reference outdated dependencies.

- The [**-H**](../userman/advanced_features/configuration/gui-config.md#p-port) short command line
option for setting the server hostname is broken.<br/>
Please use the full **--host** option instead.<br/>
This issue will be fixed in the next technical release for Taipy GUI.
To ensure a clean installation, please manually uninstall Taipy 3.x and then install a fresh
Taipy 4.0.

## New Features

Expand Down Expand Up @@ -128,7 +128,17 @@ Published on 2024-10.

## Improvements and changes

<h4><strong><code>taipy</code></strong> 4.0.0</h4>
<h4><strong><code>taipy</code></strong> 4.0.1</h4>

- The impact of the
[*show_properties*](../refmans/gui/viselements/corelements/data_node.md#p-show_properties)
property of the [`data_node`](../refmans/gui/viselements/corelements/data_node.md) control was
changed. This property now controls whether or not the "Properties" tab is visible.<br/>
To show or hide the list of custom properties in the "Properties" tab, you must now use the
[*show_custom_properties*](../refmans/gui/viselements/corelements/data_node.md#p-show_custom_properties)
property.

<h4>4.0.0</h4>

- Taipy and all its dependencies now stop support Python 3.8.<br/>
The minimum supported Python version is now 3.9.
Expand Down Expand Up @@ -232,13 +242,45 @@ Published on 2024-10.

- The *--template* option of the `taipy create` command is now renamed to *--application* option
to correctly reflect the application template to use when creating a new Taipy application.<br/>
See [issue #1472](https://github.com/Avaiga/taipy/issues/1472)
See [issue #1472](https://github.com/Avaiga/taipy/issues/1472).

## Significant bug fixes

<h4><strong><code>taipy-gui</code></strong> 4.0.0</h4>

- The value of multiline [`input`](../refmans/gui/viselements/generic/pane.md) controls is
<h4><strong><code>taipy</code></strong> 4.0.1</h4>

- Scenario selection becomes impossible in the `scenario_selector` control after creating a new
Scenario.<br/>
See [issue #2169](https://github.com/Avaiga/taipy/issues/2169).
- The Delete button of the "Edit scenario" dialog of the `scenario_selector` control is disabled
when it should not be.<br/>
See [issue #1995](https://github.com/Avaiga/taipy/issues/1995).
- A warning is issued when a scenario is created from the `scenario_selector` control.<br/>
See [issue #2009](https://github.com/Avaiga/taipy/issues/2009).
- Scenario management controls may not be fully recognized by linters or auto-completion features in
some IDEs.<br/>
See [issue #1620](https://github.com/Avaiga/taipy/issues/1620).

<h4><strong><code>taipy-gui</code></strong> 4.0.1</h4>

- The `-H` command line option is broken.<br/>
You must use the long `--host` option instead to specify the server hostname.
- The *id* and *payload* parameters of the `on_action` callback functions are swapped.<br/>
See [issue #2045](https://github.com/Avaiga/taipy/issues/2045).
- The chart control refresh may stop rendering automatically if too many data changes are
requested. The page must be refreshed manually.<br/>
See [issue #1992](https://github.com/Avaiga/taipy/issues/1992).
- Aggregation in a table control may raise an error if the table has columns holding dates.<br/>
See [issue #1994](https://github.com/Avaiga/taipy/issues/1994).
- Table columns are too narrow if there are many.<br/>
See [issue #2082](https://github.com/Avaiga/taipy/issues/2082).
- Styling is not applied to a [`table`](../refmans/gui/viselements/generic/table.md) control if its
[*rebuild*](../refmans/gui/viselements/corelements/data_node.md#p-rebuild) property is set to
True.<br/>
See [issue #2005](https://github.com/Avaiga/taipy/issues/2005).

<h4>4.0.0</h4>

- The value of multiline [`input`](../refmans/gui/viselements/generic/input.md) controls is
cleared when the ENTER key is pressed.<br/>
See [issue #1762](https://github.com/Avaiga/taipy/issues/1762).
- The [`chart`](../refmans/gui/viselements/generic/chart.md) control properly handles its
Expand Down Expand Up @@ -266,7 +308,7 @@ Published on 2024-10.

Published on 2024-10.

This release contains all of [`taipy` 4.0](https://pypi.org/project/taipy/4.0.0) as well as
This release contains all of [`taipy` 4.0](https://pypi.org/project/taipy/4.0.1) as well as
additional features.

## New Features
Expand All @@ -292,7 +334,7 @@ additional features.

## Improvements and changes

- The `taipy.export_scenario()^` function now
- The `taipy.export_scenario()^` function now:
- exports a zip archive instead of a folder.
- supports exporting file-based data nodes' data to the exported archive if the path exists.
- raises the `ExportPathAlreadyExists^`
Expand Down
34 changes: 23 additions & 11 deletions docs/release-notes/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,26 @@ title: Migration

This documentation page lists the migration paths of Taipy releases as they were published.

# From 3.x to 4.0

Due to changes in Taipy’s package structure in version 4.0, the previous version of the
`taipy-config` package may not be automatically removed when upgrading Taipy from version 3.x to
4.0. This could lead to runtime issues as the system may attempt to reference outdated dependencies.

To ensure a clean installation, please manually uninstall Taipy 3.x manually and then install a
fresh Taipy 4.0.

# From 2.x to 3.0

1. In Taipy GUI 3.0, the `on_action` callback signature was unified across all controls: the third
parameter (*action*) was dropped. The *payload* dictionary parameter that used to be in fourth
place is now in third place and contains an *action* key that is set to the action name if you
used to use *action*.

2. In Taipy 3.0 we deprecated the `pipeline` concept in favor of
[sequence](../userman/scenario_features/sdm/sequence/index.md). This also means that `configure_pipeline`
from Taipy Config was removed, making it necessary to update your config code. Take for
instance the following config on `Taipy 2.4`:
2. In Taipy 3.0 we deprecated the **Pipeline** concept in favor of
[**Sequence**](../userman/scenario_features/sdm/sequence/index.md). This also means that the
function `configure_pipeline()` was removed from Taipy Config, making it necessary to update
your config code. Take for instance the following configuration, built for Taipy 2.4:

```python title="config.py from Taipy 2.4 edition"
from taipy import Config
Expand All @@ -32,8 +41,8 @@ This documentation page lists the migration paths of Taipy releases as they were
)
```

Now, `configure_scenario` takes task configs as parameter in place of pipeline configs, so to
update the config above to `Taipy 3.0` is just a matter of:
Now, `configure_scenario()` takes task configs as parameter in place of pipeline configs, so to
update the config above to Taipy 3.0 is just a matter of:

```python title="config.py from Taipy 3.0 edition"
from taipy import Config
Expand All @@ -57,8 +66,8 @@ created with a Taipy version &#8804 2.0, the first time it runs with version 2.1
no version exists, and so legacy entities are not attached to any version. The overall principle
is to create a version the first time the application runs with Taipy 2.1 or later and to assign
all the old entities to this version. Depending on the mode used to run the application,
(Refer to [versioning documentation](../userman/advanced_features/versioning/index.md) for details) we propose
the following migration paths:
(Refer to [versioning documentation](../userman/advanced_features/versioning/index.md) for details)
we propose the following migration paths:

## Using default or development mode

Expand All @@ -70,16 +79,19 @@ mode which is the default mode, Taipy automatically creates an _experiment_ vers
current configuration and assigns all legacy entities to it. The version is named
"LEGACY-VERSION". Depending on how you want to handle legacy entities, you can now manage your
newly created version using the version management system. Please refer to the
[Version management system](../userman/advanced_features/versioning/index.md) documentation page for more details.
[Version management system](../userman/advanced_features/versioning/index.md) documentation page for
more details.

## Using experiment or production mode

Please refer to the [Experiment mode](../userman/advanced_features/versioning/experiment_mode.md) or
[Production mode](../userman/advanced_features/versioning/experiment_mode.md) documentation pages for more
[Production mode](../userman/advanced_features/versioning/experiment_mode.md) documentation pages
for more
details on how to run Taipy in experiment or production mode.

The first time you run the application with Taipy 2.1 or later, if you use _experiment_ or
_production_ mode, you can simply provide a version name to create a new version. All legacy
entities are automatically attached to this version. You can now manage your newly created
version using the version management system. Please refer to the
[Version management system](../userman/advanced_features/versioning/index.md) documentation page for more details.
[Version management system](../userman/advanced_features/versioning/index.md) documentation page for
more details.

0 comments on commit 32af514

Please sign in to comment.