From 6a8c6373c769ad9e75b23ed7f5173e279cf4cfc5 Mon Sep 17 00:00:00 2001 From: Chris Pickett Date: Thu, 1 Feb 2024 16:30:06 -0500 Subject: [PATCH] Release notes for 2.14.19 (#11804) Co-authored-by: Andrew Brookins Co-authored-by: urimandujano --- RELEASE-NOTES.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index 4cc17461879c..05737a7464b7 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -1,5 +1,78 @@ # Prefect Release Notes +## Release 2.14.19 + +## Dynamic descriptions for paused and suspended flow runs +You can now include dynamic, markdown-formatted descriptions when pausing or suspending a flow run for human input. This description will be shown in the Prefect UI alongside the form when a user is resuming the flow run, enabling developers to give context and instructions to users when they need to provide input. + +```python +from datetime import datetime +from prefect import flow, pause_flow_run, get_run_logger +from prefect.input import RunInput + +class UserInput(RunInput): + name: str + age: int + +@flow +async def greet_user(): + logger = get_run_logger() + current_date = datetime.now().strftime("%B %d, %Y") + + description_md = f""" +**Welcome to the User Greeting Flow!** +Today's Date: {current_date} + +Please enter your details below: +- **Name**: What should we call you? +- **Age**: Just a number, nothing more. +""" + + user_input = await pause_flow_run( + wait_for_input=UserInput.with_initial_data( + description=description_md, name="anonymous" + ) + ) + + if user_input.name == "anonymous": + logger.info("Hello, stranger!") + else: + logger.info(f"Hello, {user_input.name}!") +``` + +See the following PR for implementation details: +- https://github.com/PrefectHQ/prefect/pull/11776 +- https://github.com/PrefectHQ/prefect/pull/11799 + +### Enhancements +- Enhanced `RunInput` saving to include descriptions, improving clarity and documentation for flow inputs — https://github.com/PrefectHQ/prefect/pull/11776 +- Improved type hinting for automatic run inputs, enhancing the developer experience and code readability — https://github.com/PrefectHQ/prefect/pull/11796 +- Extended Azure filesystem support with the addition of `azure_storage_container` for more flexible storage options — https://github.com/PrefectHQ/prefect/pull/11784 +- Added deployment details to work pool information, offering a more comprehensive view of work pool usage — https://github.com/PrefectHQ/prefect/pull/11766 + +### Fixes +- Updated terminal based deployment operations to make links within panels interactive, enhancing user navigation and experience — https://github.com/PrefectHQ/prefect/pull/11774 + +### Documentation +- Revised Key-Value (KV) integration documentation for improved clarity and updated authorship details — https://github.com/PrefectHQ/prefect/pull/11770 +- Further refinements to interactive flows documentation, addressing feedback and clarifying usage — https://github.com/PrefectHQ/prefect/pull/11772 +- Standardized terminal output in documentation for consistency and readability — https://github.com/PrefectHQ/prefect/pull/11775 +- Corrected a broken link to agents in the work pool concepts documentation, improving resource accessibility — https://github.com/PrefectHQ/prefect/pull/11782 +- Updated examples for accuracy and to reflect current best practices — https://github.com/PrefectHQ/prefect/pull/11786 +- Added guidance on providing descriptions when pausing flow runs, enhancing operational documentation — https://github.com/PrefectHQ/prefect/pull/11799 + +### Experimental +- Implemented `TaskRunFilterFlowRunId` for both client and server, enhancing task run filtering capabilities — https://github.com/PrefectHQ/prefect/pull/11748 +- Introduced a subscription API for autonomous task scheduling, paving the way for more dynamic and flexible task execution — https://github.com/PrefectHQ/prefect/pull/11779 +- Conducted testing to ensure server-side scheduling of autonomous tasks, verifying system reliability and performance — https://github.com/PrefectHQ/prefect/pull/11793 +- Implemented a global collections metadata cache clearance between tests, improving test reliability and accuracy — https://github.com/PrefectHQ/prefect/pull/11794 +- Initiated task server testing, laying the groundwork for comprehensive server-side task management — https://github.com/PrefectHQ/prefect/pull/11797 + +## New Contributors +* @thomasfrederikhoeck made their first contribution in https://github.com/PrefectHQ/prefect/pull/11784 + +**All changes**: https://github.com/PrefectHQ/prefect/compare/2.14.18...2.14.19 + ## Release 2.14.18 ### Fixes