docs: breaking changes in components feature (#8026)
* breaking-changes-feature * dialog-not-popup * dialog * numbering * include-individual-component-update * fix-incorrect-information * cleanup
This commit is contained in:
parent
f01ba7bb0e
commit
199f2d91aa
2 changed files with 19 additions and 4 deletions
|
|
@ -66,6 +66,7 @@ For example, the [Recursive character text splitter](https://github.com/langflow
|
|||
|
||||
<details>
|
||||
<summary>Recursive character text splitter code</summary>
|
||||
|
||||
```python
|
||||
from typing import Any
|
||||
|
||||
|
|
@ -208,8 +209,24 @@ A component's initial state is stored in a database. As soon as you drag a compo
|
|||
|
||||
A component keeps the version number it is initialized to the workspace with. If a component is at version `1.0` when it is dragged to the workspace, it will stay at version `1.0` until you update it.
|
||||
|
||||
Langflow notifies you when a component's workspace version is behind the database version and an update is available.
|
||||
Click the <Icon name="AlertTriangle" aria-label="Exclamation mark" /> **Update Component** icon to update the component to the `latest` version. This will change the code of the component in place so you can validate that the component was updated by checking its Python code before and after updating it.
|
||||
### Review and update components
|
||||
|
||||
When a component's workspace version is behind the database version and an update is available, the component displays a notification.
|
||||
If there are potentially breaking changes in the component updates, Langflow notifies you with an additional dialog.
|
||||
|
||||
Breaking changes modify component inputs and outputs, and may break your flows or require you to re-connect component edges.
|
||||
|
||||
An **Update ready** notification on a component indicates the component update contains no breaking changes. To update a single component, click **Update**.
|
||||
|
||||
An **Update available** notification indicates the component update contains potentially breaking changes.
|
||||
|
||||
1. To review all components with pending updates, in the component or in the dialog, click **Review**.
|
||||
The **Update components** pane appears.
|
||||
This pane lists components in your flow with breaking changes, and includes an option to save a flow snapshot before updating.
|
||||
2. To save your flow before updating individual components, enable the **Create backup flow before updating** option.
|
||||
3. To update individual components, select them in the list, and then click **Update Component**.
|
||||
Your components are updated to the current version.
|
||||
If you created a backup flow, it's available in the same project folder as the original flow, with `(backup)` added to its name.
|
||||
|
||||
## Components sidebar
|
||||
|
||||
|
|
|
|||
|
|
@ -107,8 +107,6 @@ An example `.env` file is available in the [project repository](https://github.c
|
|||
|
||||
## Projects
|
||||
|
||||
## Projects
|
||||
|
||||
The **My Projects** page displays all the flows and components you've created in the Langflow workspace.
|
||||
|
||||

|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue