Skip to content

Commit 1c469bc

Browse files
radu-mocanuradu-mocanu
authored
docs: restructure release notes into a linked catalog (#1721)
1 parent 62751de commit 1c469bc

2 files changed

Lines changed: 19 additions & 127 deletions

File tree

‎packages/uipath/docs/core/release_notes.md‎

Lines changed: 19 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -1,126 +1,27 @@
1-
# 🚨 Breaking Changes for UiPath Python SDK (v2.2.0+)
2-
3-
**Release Date:** November 26, 2025
4-
5-
Version 2.2.0 of the **UiPath Python SDK** introduces several breaking changes affecting both the SDK and CLI.
6-
7-
## Breaking Changes
8-
9-
### 1. Minimum Python Version: 3.11+ Required
10-
11-
**What's changing:** Python 3.10 is no longer supported for `uipath-python`, `uipath-langchain-python`, `uipath-llamaindex-python`.
12-
13-
**Action required:** Upgrade to Python 3.11 or higher.
14-
15-
### 2. Import Path Change
16-
17-
**What's changing:** The `UiPath` class has moved from `uipath` to `uipath.platform`.
18-
19-
**Action required:** Update your imports:
20-
21-
```python
22-
# Before
23-
from uipath import UiPath
24-
from uipath.models import Job, Asset, Queue
25-
from uipath.models import Entity
26-
27-
# After
28-
from uipath.platform import UiPath, Job, Asset, Queue
29-
30-
client = UiPath(...)
31-
```
32-
33-
### 3. Transition to LangChain v1 (for `uipath-langchain` only)
34-
35-
**What's changing:** Minimum required versions are now LangChain 1.0.0+ and LangGraph 1.0.0+
36-
37-
**Action required:** Review and update your code according to the [LangChain v1 Migration Guide](https://docs.langchain.com/oss/python/migrate/langchain-v1).
38-
39-
**Note:** This only applies if you're using the `uipath-langchain` package.
40-
41-
### 4. Configuration Architecture Redesign
42-
43-
We've restructured how UiPath projects define and manage their resources:
44-
45-
**`uipath.json` - Configuration File (Updated Purpose)**
46-
- Previously contained entrypoints and bindings; now serves as a streamlined configuration file
47-
- For **pure Python scripts**, define entrypoints in the `functions` section:
48-
```json
49-
{
50-
"functions": {
51-
"entrypoint1": "src/main.py:",
52-
"entrypoint2": "src/graph.py:runtime"
53-
}
54-
}
55-
```
56-
- For **LangGraph graphs**, define entrypoints in `langgraph.json` (same as before)
57-
- For **LlamaIndex workflows**, define entrypoints in `llamaindex.json` (same as before)
58-
59-
**`bindings.json` - Manual Binding Definitions (New)**
60-
- Overridable resources (bindings) now stored in a separate file
61-
- Bindings are **no longer automatically inferred** from code
62-
- Must be manually defined by the user for now (we're working on an interactive configurator to simplify this process)
63-
64-
**`entry-points.json` - I/O Schema (New)**
65-
- Contains the input/output schema for your entrypoints
66-
- Automatically inferred from code based on entrypoints defined in `llamaindex.json`/`langgraph.json`/`uipath.json`
67-
68-
## Migration Guide
69-
70-
### Stay on v2.1.x
71-
72-
To avoid these breaking changes and keep your current setup, pin your dependency in `pyproject.toml`:
73-
74-
```toml
75-
"uipath>=2.1.x,<2.2.0"
76-
```
77-
78-
**For `uipath-langchain` users:** To stay on the current version without LangChain v1:
79-
```toml
80-
"uipath-langchain>=0.0.x,<0.1.0"
81-
```
82-
83-
### Migrate to v2.2.0+
1+
---
2+
title: Release Notes
3+
---
844

85-
1. **Upgrade to v2.2.0+**
86-
87-
Update the dependencies in `pyproject.toml` with:
88-
```toml
89-
"uipath>=2.2.x,<2.3.0"
90-
```
5+
# Release Notes
916

92-
Bounding the version to <2.3.0 prevents future breaking changes
93-
94-
**For `uipath-langchain` users:**
95-
To migrate to LangChain v1:
96-
```toml
97-
"uipath-langchain>=0.1.0,<0.2.0"
98-
```
99-
**For `uipath-langchain`/`uipath-llamaindex` users:**
100-
Make sure to also reference `uipath` in your `pyproject.toml` - future versions will no longer reference the main `uipath` CLI package as a dependency.
7+
A catalog of the releases most relevant to UiPath Python SDK users (breaking changes and notable updates). Full details live in each GitHub release, linked below.
1018

102-
2. **Upgrade the Python version to 3.11+**
103-
104-
In `pyproject.toml` specify the required Python version by adding or updating the following field:
105-
```toml
106-
requires-python = ">=3.11"
107-
```
9+
## `uipath` (SDK & CLI)
10810

109-
3. **Update imports**
110-
111-
Change `from uipath import UiPath` to `from uipath.platform import UiPath`.
11+
| Release | Date | What's relevant | Notes |
12+
|---------|------|-----------------|-------|
13+
| [v2.10.0](https://github.com/UiPath/uipath-python/releases/tag/v2.10.0) | 2026-02-27 | Coded function schema `type` changed from `"agent"` to `"function"` | 🚨 Breaking |
14+
| [v2.9.0](https://github.com/UiPath/uipath-python/releases/tag/v2.9.0) | 2026-02-23 | `platform` extracted to `uipath-platform`, context grounding contract changes, `uipath dev` defaults to `web` | 🚨 Breaking |
15+
| [v2.2.0](https://github.com/UiPath/uipath-python/releases/tag/v2.2.0) | 2025-11-26 | Python 3.11+ required, `UiPath` import moved to `uipath.platform`, configuration architecture redesign | 🚨 Breaking |
11216

113-
4. **Review LangChain v1 changes (if using `uipath-langchain`)**
114-
115-
Review the [LangChain v1 Migration Guide](https://docs.langchain.com/oss/python/migrate/langchain-v1) and update your code accordingly.
17+
## `uipath-langchain`
11618

117-
5. **Update configuration files**
118-
119-
- **Define your entrypoints** in `scripts` within `uipath.json` (not applicable if you already use `langgraph.json`/`llamaindex.json`)
120-
- **Run `uipath init`** to automatically generate the `entry-points.json` I/O schema from your configuration
121-
- **Create `bindings.json`** and manually define all overridable resources
122-
- **Important:** If you update your script/agent code, run `uipath init` again to regenerate the I/O schema
19+
| Release | Date | What's relevant | Notes |
20+
|---------|------|-----------------|-------|
21+
| [v0.10.0](https://github.com/UiPath/uipath-langchain-python/releases/tag/v0.10.0) | 2026-04-23 | Transport/auth split into new `uipath-llm-client` and `uipath-langchain-client` packages (legacy preserved) | Non-breaking |
12322

124-
---
23+
## `uipath-runtime`
12524

126-
For questions or issues, please open a ticket: [UiPath Python SDK Submit Issue](https://github.com/UiPath/uipath-python/issues)
25+
| Release | Date | What's relevant | Notes |
26+
|---------|------|-----------------|-------|
27+
| [v0.3.0](https://github.com/UiPath/uipath-runtime-python/releases/tag/v0.3.0) | 2025-12-18 | `UiPathDebugBridgeProtocol` renamed to `UiPathDebugProtocol` | 🚨 Breaking (protocol implementers only) |

‎packages/uipath/docs/index.md‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,6 @@
22
title: Getting Started
33
---
44

5-
<div class="grid cards" markdown>
6-
- __🚨 Breaking changes__
7-
8-
---
9-
10-
UiPath Python SDK v2.2.0+ will introduce **breaking changes** starting **November 26, 2025**
11-
[See Details](./core/release_notes.md)
12-
</div>
13-
145
<h2>What do you want to build?</h2>
156

167
<div class="grid cards" markdown>

0 commit comments

Comments
 (0)