8.1 Upgrade Guide¶
This guide describes the changes to account for when upgrading @orchestrator-ui/orchestrator-ui-components from 7.x
to 8.1.
Compatibility with Orchestrator Core¶
Orchestrator UI Library 8.1 adds editing features that depend on APIs introduced in Orchestrator Core 5.0. The combination of these versions together supports the following new functionality:
- Editing the note on a workflow, which uses
PATCH /processes/{process_id} - Editing a product’s lifecycle status, which uses
PATCH /products/{product_id}
See the Core 5.0 upgrade guide for the backend migration steps.
Upgrade from a version before 8.0¶
Release 8.0 upgraded the pydantic-forms dependency from 1.x to 2.x. If you are upgrading from UI Library
7.x, account for this change as part of the 8.1 upgrade.
Custom Pydantic form components¶
pydantic-forms 2.x compiles the configured componentMatcherExtender into a componentMatcher when it initializes a
form. Custom components that read the form configuration with useGetConfig() must use
the componentMatcher instead of componentMatcherExtender.
If your application imports pydantic-forms directly, update it to 2.x and check its
2.0.0 changelog
for other changes that affect custom form integrations.