Skip to content

Commit 6ee9ded

Browse files
devin-ai-integration[bot]bot_apk
andauthored
docs: Add release notes for 3.6.22 (#21106)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: bot_apk <apk@cognition.ai>
1 parent 5188608 commit 6ee9ded

File tree

61 files changed

+1922
-1169
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1922
-1169
lines changed

docs/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1720,6 +1720,7 @@
17201720
]
17211721
},
17221722
"v3/api-ref/python/prefect-settings-models-tasks",
1723+
"v3/api-ref/python/prefect-settings-models-telemetry",
17231724
"v3/api-ref/python/prefect-settings-models-testing",
17241725
"v3/api-ref/python/prefect-settings-models-worker"
17251726
]
@@ -2795,4 +2796,4 @@
27952796
}
27962797
],
27972798
"theme": "mint"
2798-
}
2799+
}

docs/v3/api-ref/python/prefect-cli-block.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ block_inspect(slug: Annotated[Optional[str], cyclopts.Parameter(help='A Block sl
6868
Displays details about a configured block.
6969

7070

71-
### `list_types` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L455" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
71+
### `list_types` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L472" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
7272

7373
```python
7474
list_types()
@@ -78,7 +78,7 @@ list_types()
7878
List all block types.
7979

8080

81-
### `blocktype_inspect` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L509" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
81+
### `blocktype_inspect` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L526" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
8282

8383
```python
8484
blocktype_inspect(slug: Annotated[str, cyclopts.Parameter(help='A block type slug')])
@@ -88,7 +88,7 @@ blocktype_inspect(slug: Annotated[str, cyclopts.Parameter(help='A block type slu
8888
Display details about a block type.
8989

9090

91-
### `blocktype_delete` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L545" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
91+
### `blocktype_delete` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/block.py#L583" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
9292

9393
```python
9494
blocktype_delete(slug: Annotated[str, cyclopts.Parameter(help='A Block type slug')])

docs/v3/api-ref/python/prefect-cli-cloud-__init__.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Cloud command — authenticate and interact with Prefect Cloud.
1212

1313
## Functions
1414

15-
### `login` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/__init__.py#L55" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
15+
### `login` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/__init__.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1616

1717
```python
1818
login()
@@ -24,7 +24,7 @@ Creates a new profile configured to use the specified PREFECT_API_KEY.
2424
Uses a previously configured profile if it exists.
2525

2626

27-
### `logout` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/__init__.py#L283" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
27+
### `logout` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/__init__.py#L284" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2828

2929
```python
3030
logout()
@@ -35,7 +35,7 @@ Logout the current workspace.
3535
Reset PREFECT_API_KEY and PREFECT_API_URL to default.
3636

3737

38-
### `workspace_ls` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/__init__.py#L316" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
38+
### `workspace_ls` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/__init__.py#L317" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
3939

4040
```python
4141
workspace_ls()
@@ -45,7 +45,7 @@ workspace_ls()
4545
List available workspaces.
4646

4747

48-
### `workspace_set` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/__init__.py#L350" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
48+
### `workspace_set` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/__init__.py#L374" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
4949

5050
```python
5151
workspace_set()

docs/v3/api-ref/python/prefect-cli-cloud-webhook.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Manage Prefect Cloud Webhooks.
1010

1111
## Functions
1212

13-
### `webhook_ls` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L31" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
13+
### `webhook_ls` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L32" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1414

1515
```python
1616
webhook_ls()
@@ -20,7 +20,7 @@ webhook_ls()
2020
Fetch and list all webhooks in your workspace.
2121

2222

23-
### `webhook_get` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L46" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
23+
### `webhook_get` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L66" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2424

2525
```python
2626
webhook_get(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook ID to retrieve.')])
@@ -30,7 +30,7 @@ webhook_get(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook ID
3030
Retrieve a webhook by ID.
3131

3232

33-
### `webhook_create` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L63" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
33+
### `webhook_create` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L99" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
3434

3535
```python
3636
webhook_create(webhook_name: Annotated[str, cyclopts.Parameter(help='The name of the webhook.')])
@@ -40,7 +40,7 @@ webhook_create(webhook_name: Annotated[str, cyclopts.Parameter(help='The name of
4040
Create a new Cloud webhook.
4141

4242

43-
### `webhook_rotate` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L107" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
43+
### `webhook_rotate` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L143" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
4444

4545
```python
4646
webhook_rotate(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook ID to rotate.')])
@@ -50,7 +50,7 @@ webhook_rotate(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook
5050
Rotate url for an existing Cloud webhook, in case it has been compromised.
5151

5252

53-
### `webhook_toggle` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L130" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
53+
### `webhook_toggle` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L166" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
5454

5555
```python
5656
webhook_toggle(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook ID to toggle.')])
@@ -60,7 +60,7 @@ webhook_toggle(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook
6060
Toggle the enabled status of an existing Cloud webhook.
6161

6262

63-
### `webhook_update` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L154" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
63+
### `webhook_update` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L190" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
6464

6565
```python
6666
webhook_update(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook ID to update.')])
@@ -70,7 +70,7 @@ webhook_update(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook
7070
Partially update an existing Cloud webhook.
7171

7272

73-
### `webhook_delete` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L192" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
73+
### `webhook_delete` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L228" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
7474

7575
```python
7676
webhook_delete(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook ID to delete.')])

docs/v3/api-ref/python/prefect-cli-concurrency_limit.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ ls()
4444
View all concurrency limits.
4545

4646

47-
### `reset` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/concurrency_limit.py#L167" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
47+
### `reset` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/concurrency_limit.py#L193" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
4848

4949
```python
5050
reset(tag: str)
@@ -54,7 +54,7 @@ reset(tag: str)
5454
Resets the concurrency limit slots set on the specified tag.
5555

5656

57-
### `delete` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/concurrency_limit.py#L183" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
57+
### `delete` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/concurrency_limit.py#L209" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
5858

5959
```python
6060
delete(tag: str)

docs/v3/api-ref/python/prefect-cli-config.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Manages Prefect settings and profiles.
1414

1515
## Functions
1616

17-
### `set_` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/config.py#L35" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
17+
### `set_` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/config.py#L36" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1818

1919
```python
2020
set_(settings: Annotated[list[str], cyclopts.Parameter(help='Settings in VAR=VAL format')]) -> None
@@ -24,7 +24,7 @@ set_(settings: Annotated[list[str], cyclopts.Parameter(help='Settings in VAR=VAL
2424
Change the value for a setting by setting the value in the current profile.
2525

2626

27-
### `validate` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/config.py#L89" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
27+
### `validate` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/config.py#L90" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2828

2929
```python
3030
validate() -> None
@@ -36,7 +36,7 @@ Read and validate the current profile.
3636
Deprecated settings will be automatically converted to new names.
3737

3838

39-
### `unset` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/config.py#L105" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
39+
### `unset` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/config.py#L106" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
4040

4141
```python
4242
unset(setting_names: Annotated[list[str], cyclopts.Parameter(help='Setting names to unset')]) -> None
@@ -48,7 +48,7 @@ Restore the default value for a setting.
4848
Removes the setting from the current profile.
4949

5050

51-
### `view` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/config.py#L161" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
51+
### `view` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/config.py#L162" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
5252

5353
```python
5454
view() -> None

docs/v3/api-ref/python/prefect-cli-flow.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ View and serve flows.
1414

1515
## Functions
1616

17-
### `ls` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow.py#L37" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
17+
### `ls` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow.py#L38" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1818

1919
```python
2020
ls()
@@ -24,7 +24,7 @@ ls()
2424
View flows.
2525

2626

27-
### `serve` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow.py#L68" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
27+
### `serve` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow.py#L92" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2828

2929
```python
3030
serve(entrypoint: str)

docs/v3/api-ref/python/prefect-cli-flow_run.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ logs(id: UUID)
7474
View logs for a flow run.
7575

7676

77-
### `execute` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow_run.py#L601" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
77+
### `execute` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/flow_run.py#L629" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
7878

7979
```python
8080
execute(id: Optional[UUID] = None)

docs/v3/api-ref/python/prefect-cli-profile.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ ls()
2424
List profile names.
2525

2626

27-
### `create` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L64" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
27+
### `create` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2828

2929
```python
3030
create(name: str)
@@ -34,7 +34,7 @@ create(name: str)
3434
Create a new profile.
3535

3636

37-
### `use` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L118" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
37+
### `use` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L139" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
3838

3939
```python
4040
use(name: str)
@@ -44,7 +44,7 @@ use(name: str)
4444
Set the given profile to active.
4545

4646

47-
### `delete` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L190" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
47+
### `delete` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L211" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
4848

4949
```python
5050
delete(name: str)
@@ -54,7 +54,7 @@ delete(name: str)
5454
Delete the given profile.
5555

5656

57-
### `rename` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L219" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
57+
### `rename` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L240" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
5858

5959
```python
6060
rename(name: str, new_name: str)
@@ -64,7 +64,7 @@ rename(name: str, new_name: str)
6464
Change the name of a profile.
6565

6666

67-
### `inspect` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L249" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
67+
### `inspect` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L270" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
6868

6969
```python
7070
inspect(name: Annotated[Optional[str], cyclopts.Parameter(help='Name of profile to inspect; defaults to active.')] = None)
@@ -74,7 +74,7 @@ inspect(name: Annotated[Optional[str], cyclopts.Parameter(help='Name of profile
7474
Display settings from a given profile; defaults to active.
7575

7676

77-
### `populate_defaults` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L300" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
77+
### `populate_defaults` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L321" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
7878

7979
```python
8080
populate_defaults()
@@ -85,15 +85,15 @@ Populate the profiles configuration with default base profiles,
8585
preserving existing user profiles.
8686

8787

88-
### `check_server_connection` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L389" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
88+
### `check_server_connection` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L410" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
8989

9090
```python
9191
check_server_connection() -> ConnectionStatus
9292
```
9393

9494
## Classes
9595

96-
### `ConnectionStatus` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L378" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
96+
### `ConnectionStatus` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/profile.py#L399" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
9797

9898
**Methods:**
9999

0 commit comments

Comments
 (0)