Prepare release 0.82.1 (#3667)

* Adding the new version to the necessary files.

* release notes

---------

Co-authored-by: ZenML GmbH <[email protected]>
Co-authored-by: Baris Can Durak <[email protected]>

Author: 3 people

README.md

@@ -386,7 +386,7 @@ the Apache License Version 2.0.
     <a href="https://github.com/zenml-io/zenml-projects">Projects Showcase</a>
     <br />
     <br />
-    🎉 Version 0.82.0 is out. Check out the release notes
+    🎉 Version 0.82.1 is out. Check out the release notes
     <a href="https://github.com/zenml-io/zenml/releases">here</a>.
     <br />
     🖥️ Download our VS Code Extension <a href="https://marketplace.visualstudio.com/items?itemName=ZenML.zenml-vscode">here</a>.

RELEASE_NOTES.md

@@ -1,10 +1,80 @@
 <!-- markdown-link-check-disable -->
 
+# 0.82.1
+
+The `0.82.1` release focuses on incremental improvements to [run template](https://docs.zenml.io/concepts/templates) management, [Kubernetes orchestration](https://docs.zenml.io/stacks/stack-components/orchestrators/kubernetes), [Docker build performance](https://docs.zenml.io/concepts/containerization), and overall robustness, while shipping a wide range of documentation updates and quality-of-life enhancements. Key highlights include configurable Kubernetes job clean-up behavior, cascading tags for cached step runs, [`pyproject.toml` support for `DockerSettings`](https://docs.zenml.io/concepts/containerization#python-dependencies), improved login stability, and faster Docker build caching through parent image digests.
+
+## Features
+
+- Added [`pyproject.toml` support for configuring `DockerSettings`](https://docs.zenml.io/concepts/containerization#python-dependencies), making container builds easier to manage.
+- Added a unique instance label to the Helm chart to simplify the operation of multiple ZenML deployments in the same cluster.
+- Introduced a new stress-test example that showcases ZenML scalability and can be used to benchmark installations.
+
+## Improvements
+
+- Added cascading tags for cached step runs to improve cache reuse and pipeline run performance.
+- Added configurable Kubernetes job clean-up options for the Kubernetes orchestrator.
+- Added a limit to the maximum number of concurrent template runs and improved the overall run template UX.
+- Prevented unnecessary hydration in project-scoped API responses, reducing payload size and improving performance.
+- Optimized Docker build caching by using parent image digests and extending development Dockerfiles.
+- Pinned `setuptools` to a stable version and removed redundant script dependencies to avoid build failures.
+
+## Fixes
+
+- Fixed DockerHub repository digest detection when building images.
+- Fixed miscellaneous login issues and introduced an API login lock for added robustness.
+- Fixed dashboard bolt icon rendering.
+- Updated Alembic to address compatibility issues.
+
+## Documentation
+
+- Added a ["5-minute quick wins" guide](https://docs.zenml.io/user-guides/best-practices/quick-wins) and [a new dedicated docs section regarding orchestrator selection](https://docs.zenml.io/user-guides/best-practices/choose-orchestration-environment).
+- Added [documentation for dashboard features](https://docs.zenml.io/concepts/dashboard-features) and an accurate list of workload manager options.
+- Added `0.81.0` to legacy docs and fixed [artifact visualization guidance](https://zenml-io.gitbook.io/barisky/concepts/artifacts/visualizations).
+- Numerous minor documentation fixes and cleanup.
+
+
+## What's Changed
+* Adding 0.81.0 to the legacy docs by @bcdurak in https://github.com/zenml-io/zenml/pull/3630
+* Extending the Dockerfiles  by @bcdurak in https://github.com/zenml-io/zenml/pull/3632
+* Use parent image digest for cache invalidation by @schustmi in https://github.com/zenml-io/zenml/pull/3617
+* Pro API login lock and other robustness improvements by @stefannica in https://github.com/zenml-io/zenml/pull/3625
+* Fixing images for the Hello World and various other fixes by @bcdurak in https://github.com/zenml-io/zenml/pull/3637
+* Pin setuptools and remove it from scripts by @stefannica in https://github.com/zenml-io/zenml/pull/3636
+* Update link validation to skip GitHub links and improve progress tracking by @htahir1 in https://github.com/zenml-io/zenml/pull/3641
+* Added docs section by @AlexejPenner in https://github.com/zenml-io/zenml/pull/3640
+* Various improvements to the release flow by @bcdurak in https://github.com/zenml-io/zenml/pull/3638
+* Fix Dockerhub repo digest detection by @schustmi in https://github.com/zenml-io/zenml/pull/3621
+* Add unique instance label to helm chart by @stefannica in https://github.com/zenml-io/zenml/pull/3639
+* Slight doc fix. Fixes #3645 by @htahir1 in https://github.com/zenml-io/zenml/pull/3646
+* Add 5-min quick wins page to docs by @strickvl in https://github.com/zenml-io/zenml/pull/3633
+* Limit max concurrent template runs by @schustmi in https://github.com/zenml-io/zenml/pull/3627
+* Fix bolt icon by @strickvl in https://github.com/zenml-io/zenml/pull/3648
+* Update docs with accurate list of workload manager options by @stefannica in https://github.com/zenml-io/zenml/pull/3643
+* Workflow to deploy workspaces for PRs by @bcdurak in https://github.com/zenml-io/zenml/pull/3618
+* Format link checker by @schustmi in https://github.com/zenml-io/zenml/pull/3656
+* Improve run template UX by @schustmi in https://github.com/zenml-io/zenml/pull/3602
+* Prevent unnecessary hydration in project-scoped responses by @schustmi in https://github.com/zenml-io/zenml/pull/3657
+* Update alembic version to "^1.8.1" in pyproject.toml by @htahir1 in https://github.com/zenml-io/zenml/pull/3529
+* Fixing artifact visualization docs by @bcdurak in https://github.com/zenml-io/zenml/pull/3661
+* Add stress test example by @stefannica in https://github.com/zenml-io/zenml/pull/3663
+* Misc login fixes by @schustmi in https://github.com/zenml-io/zenml/pull/3654
+* Report run template trigger usage by @schustmi in https://github.com/zenml-io/zenml/pull/3659
+* Specify end date for template runs that failed during spinup by @schustmi in https://github.com/zenml-io/zenml/pull/3664
+* Make Kubernetes job cleanup options configurable by @schustmi in https://github.com/zenml-io/zenml/pull/3644
+* Dashboard features documentation by @strickvl in https://github.com/zenml-io/zenml/pull/3662
+* Pyproject.toml support for DockerSettings by @schustmi in https://github.com/zenml-io/zenml/pull/3292
+* Utilizing cascading tags for cached step runs by @bcdurak in https://github.com/zenml-io/zenml/pull/3655
+
+
+**Full Changelog**: https://github.com/zenml-io/zenml/compare/0.82.0...0.82.1
+
+
 # 0.82.0
 
 The 0.82.0 release delivers significant improvements to [Kubernetes orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/kubernetes), enhanced documentation, and numerous fixes to improve overall stability and performance. Key highlights include configurable max parallelism for Kubernetes orchestrator, customizable pod name prefixes and scheduler options, improved runner timeouts, and support for private service connections in Vertex AI. This release also includes comprehensive documentation updates, and library compatibility improvements for NumPy and Pandas.
 
-# Features
+## Features
 
 - Added max parallelism option for [Kubernetes orchestrator](https://docs.zenml.io/stacks/stack-components/orchestrators/kubernetes)
 - Added support for pod name prefixes and scheduler configuration
@@ -13,7 +83,7 @@ The 0.82.0 release delivers significant improvements to [Kubernetes orchestrator
 - Added storage for list of Python packages
 - Added an ability to deep refresh the status of your run from the dashboard
 
-# Improvements
+## Improvements
 
 - Adjusted GitHub code repo regex pattern for better compatibility
 - Improved build invalidation when parent Dockerfile changes
@@ -22,7 +92,7 @@ The 0.82.0 release delivers significant improvements to [Kubernetes orchestrator
 - Added support for extra attributes in all ZenML models
 - Disabled default project behavior for pro workspaces
 
-# Fixes
+## Fixes
 
 - Fixed run templates listing
 - Eliminated premature active project warning logs
@@ -32,7 +102,7 @@ The 0.82.0 release delivers significant improvements to [Kubernetes orchestrator
 - Removed unnecessary and invalid settings
 - Various frontend bug fixes
 
-# Documentation
+## Documentation
 
 - Completed comprehensive documentation revamp
 - Added documentation for [self-hosted run templates](https://docs.zenml.io/pro/deployments/self-hosted#enabling-run-templates-support)
@@ -42,7 +112,7 @@ The 0.82.0 release delivers significant improvements to [Kubernetes orchestrator
 - Updated image paths for ZenML pipeline screenshots
 - Migrated starter guide to unified log_metadata method
 
-# Breaking Changes
+## Breaking Changes
 
 - Removed `scikit-image` as a requirement of the sklearn integration
 

examples/quickstart/configs/training_aws.yaml

@@ -1,7 +1,7 @@
 # Environment configuration
 settings:
   docker:
-    parent_image: "715803424590.dkr.ecr.eu-central-1.amazonaws.com/zenml-public-pipelines:quickstart-0.82.0-py3.11-aws"
+    parent_image: "715803424590.dkr.ecr.eu-central-1.amazonaws.com/zenml-public-pipelines:quickstart-0.82.1-py3.11-aws"
     skip_build: True  # If you switch this to False remove the parent_image
     requirements: requirements.txt
     environment:

examples/quickstart/configs/training_azure.yaml

@@ -1,7 +1,7 @@
 # Environment configuration
 settings:
   docker:
-    parent_image: "zenmldocker/zenml-public-pipelines:quickstart-0.82.0-py3.11-azure"
+    parent_image: "zenmldocker/zenml-public-pipelines:quickstart-0.82.1-py3.11-azure"
     skip_build: True
     requirements: requirements.txt
     environment:

examples/quickstart/configs/training_gcp.yaml

@@ -1,7 +1,7 @@
 # Environment configuration
 settings:
   docker:
-    parent_image: "zenmldocker/zenml-public-pipelines:quickstart-0.82.0-py3.11-gcp"
+    parent_image: "zenmldocker/zenml-public-pipelines:quickstart-0.82.1-py3.11-gcp"
     skip_build: True
     requirements: requirements.txt
     environment:

examples/quickstart/quickstart.ipynb

@@ -499,7 +499,7 @@
         "# Common imports and setup\n",
         "if CLOUD_PROVIDER.lower() == \"gcp\":\n",
         "    parent_image = (\n",
-        "        \"zenmldocker/zenml-public-pipelines:quickstart-0.82.0-py3.11-gcp\"\n",
+        "        \"zenmldocker/zenml-public-pipelines:quickstart-0.82.1-py3.11-gcp\"\n",
         "    )\n",
         "    skip_build = True\n",
         "\n",
@@ -508,7 +508,7 @@
         "        SagemakerOrchestratorSettings,\n",
         "    )\n",
         "\n",
-        "    parent_image = \"339712793861.dkr.ecr.eu-central-1.amazonaws.com/zenml-public-pipelines:quickstart-0.82.0-py3.11-aws\"\n",
+        "    parent_image = \"339712793861.dkr.ecr.eu-central-1.amazonaws.com/zenml-public-pipelines:quickstart-0.82.1-py3.11-aws\"\n",
         "    skip_build = True  # if you switch this to False, you need to remove the parent image\n",
         "\n",
         "    settings[\"orchestrator.sagemaker\"] = SagemakerOrchestratorSettings(\n",
@@ -517,7 +517,7 @@
         "\n",
         "elif CLOUD_PROVIDER.lower() == \"azure\":\n",
         "    parent_image = (\n",
-        "        \"zenmldocker/zenml-public-pipelines:quickstart-0.82.0-py3.11-azure\"\n",
+        "        \"zenmldocker/zenml-public-pipelines:quickstart-0.82.1-py3.11-azure\"\n",
         "    )\n",
         "    skip_build = True\n",
         "\n",

examples/quickstart/requirements.txt

@@ -1,4 +1,4 @@
-zenml[server]==0.82.0
+zenml[server]==0.82.1
 notebook
 pyarrow
 datasets

examples/quickstart/requirements_aws.txt

@@ -1,4 +1,4 @@
-zenml[server]==0.82.0
+zenml[server]==0.82.1
 notebook
 pyarrow
 datasets

examples/quickstart/requirements_azure.txt

@@ -1,4 +1,4 @@
-zenml[server]==0.82.0
+zenml[server]==0.82.1
 notebook
 pyarrow
 datasets

examples/quickstart/requirements_gcp.txt

@@ -1,4 +1,4 @@
-zenml[server]==0.82.0
+zenml[server]==0.82.1
 notebook
 pyarrow
 datasets

helm/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: zenml
-version: "0.82.0"
+version: "0.82.1"
 description: Open source MLOps framework for portable production ready ML pipelines
 keywords:
 - mlops

helm/README.md

@@ -20,8 +20,8 @@ ZenML is an open-source MLOps framework designed to help you create robust, main
 To install the ZenML chart directly from Amazon ECR, use the following command:
 
 ```bash
-# example command for version 0.82.0
-helm install my-zenml oci://public.ecr.aws/zenml/zenml --version 0.82.0
+# example command for version 0.82.1
+helm install my-zenml oci://public.ecr.aws/zenml/zenml --version 0.82.1
 ```
 
 Note: Ensure you have OCI support enabled in your Helm client and that you are authenticated with Amazon ECR.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zenml"
-version = "0.82.0"
+version = "0.82.1"
 packages = [{ include = "zenml", from = "src" }]
 description = "ZenML: Write production-ready ML code."
 authors = ["ZenML GmbH <[email protected]>"]

src/zenml/VERSION

@@ -1 +1 @@
-0.82.0
+0.82.1

src/zenml/zen_stores/migrations/versions/0.82.1_release.py

@@ -0,0 +1,23 @@
+"""Release [0.82.1].
+
+Revision ID: 0.82.1
+Revises: 0.82.0
+Create Date: 2025-05-14 07:47:30.641830
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "0.82.1"
+down_revision = "0.82.0"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    """Upgrade database schema and/or data, creating a new revision."""
+    pass
+
+
+def downgrade() -> None:
+    """Downgrade database schema and/or data back to the previous revision."""
+    pass