From 5ebb493b01c4581ca1f22996aaeca5311b22b956 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Tue, 18 Feb 2025 10:14:44 -0800 Subject: [PATCH 1/4] Removed references to blog in breaking changes README --- site/releases/breaking-changes/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/site/releases/breaking-changes/README.md b/site/releases/breaking-changes/README.md index 010273d6e7..f8aba4fc11 100644 --- a/site/releases/breaking-changes/README.md +++ b/site/releases/breaking-changes/README.md @@ -71,7 +71,7 @@ Make a copy of `~/releases/breaking-changes/year.csv` in the `~/releases/breakin #### Create collateral -You'll need the links for the release notes and any blog posts associated with the breaking change or deprecation to include in the table, so make sure those are published that first unless you want to fill them in at a later date. +You'll need the links for the release notes associated with the breaking change or deprecation to include in the table, so make sure those are published that first unless you want to fill them in at a later date. #### Enter an entry @@ -85,7 +85,6 @@ Open up the `.csv` for the year you want to update and create a new entry under | Type | Whether it's a breaking change or deprecation | `Deprecation` | | Date announced | ISO 8601 date of announcement | `2024-01-26` | | Release notes | Markdown format **HTML** link to the associated release notes enclosed by `""` | `"[Read](/releases/2024/2024-jan-26/highlights.html#standard-inputs-are-deprecated)"` | -| Blog post | Markdown format link to the associated blog post enclosed by `""` | `"[Read](https://validmind.com/blog/)"` | | Date effective | ISO 8601 date of feature removal/deprecation | `2024-01-26` | > [!NOTE] From 97bab7674aef1929c0870889be81847857b74135 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Tue, 18 Feb 2025 10:19:52 -0800 Subject: [PATCH 2/4] Adding breaking-change tag to PR template --- .github/pull_request_template.md | 3 ++- site/releases/2024/2024-jan-26/highlights.qmd | 25 +++++++++++-------- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6b84df5b98..0947af5637 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,8 +8,9 @@ PR instructions for release notes: - `internal` (skip Step 2, no release notes required) - `highlight` - `enhancement` -- `bug` +- `breaking-change` - `deprecation` +- `bug` - `documentation` 2. In the next section, describe the changes so that an external user can understand them. Keep it simple and link to the docs with [Learn more ...](), if available. diff --git a/site/releases/2024/2024-jan-26/highlights.qmd b/site/releases/2024/2024-jan-26/highlights.qmd index e4d6506b96..9325503592 100644 --- a/site/releases/2024/2024-jan-26/highlights.qmd +++ b/site/releases/2024/2024-jan-26/highlights.qmd @@ -295,6 +295,21 @@ To work with Azure OpenAI API endpoints, you need to set the following environme - We have updated our demonstration notebooks for large language models (LLMs) to provide the correct support for `openai >= 1.0.0`. - Previously, some notebooks were using an older version of the OpenAI client API. +## Breaking changes + +### {{< var validmind.developer >}} (v1.25.3) + + +#### Removed deprecated {{< var validmind.api >}} methods + +The {{< var vm.api >}} methods `run_template` and `run_test_plan` had been deprecated previously. They have now been removed from the {{< var validmind.developer >}}. + +You'll need to update your code to use the recommended high-level API methods: + +- **`run_template` (removed):** Use [`run_documentation_tests()`](/validmind/validmind.html#run_documentation_tests){target="_blank"} +- **`run_test_plan` (removed):** Use [`run_test_suite()`](/validmind/validmind.html#run_test_suite){target="_blank"} + + ## Deprecations ### {{< var validmind.developer >}} (v1.25.3) @@ -337,16 +352,6 @@ The {{< var validmind.developer >}} now supports passing custom inputs[^3] as an :::: - -#### Removed deprecated {{< var validmind.api >}} methods - -The {{< var vm.api >}} methods `run_template` and `run_test_plan` had been deprecated previously. They have now been removed from the {{< var validmind.developer >}}. - -You'll need to update your code to use the recommended high-level API methods: - -- **`run_template` (removed):** Use [`run_documentation_tests()`](/validmind/validmind.html#run_documentation_tests){target="_blank"} -- **`run_test_plan` (removed):** Use [`run_test_suite()`](/validmind/validmind.html#run_test_suite){target="_blank"} - ## Documentation ### User guide updates From c566f1c943be1b1917931c0013b27b819cf9117a Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Tue, 18 Feb 2025 10:28:59 -0800 Subject: [PATCH 3/4] Adding the breaking-change tag to release categories --- release-scripts/generate-release-notes.ipynb | 2 +- release-scripts/generate_release_objects.py | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/release-scripts/generate-release-notes.ipynb b/release-scripts/generate-release-notes.ipynb index 8c8f8e7496..1158fb9951 100644 --- a/release-scripts/generate-release-notes.ipynb +++ b/release-scripts/generate-release-notes.ipynb @@ -155,7 +155,7 @@ "metadata": {}, "outputs": [], "source": [ - "label_hierarchy = [\"highlight\", \"enhancement\", \"deprecation\", \"bug\", \"documentation\"]\n", + "label_hierarchy = [\"highlight\", \"enhancement\", \"breaking-change\", \"deprecation\", \"bug\", \"documentation\"]\n", "gro.display_list(label_hierarchy)" ] }, diff --git a/release-scripts/generate_release_objects.py b/release-scripts/generate_release_objects.py index 53fa50e48e..57a6c5e478 100644 --- a/release-scripts/generate_release_objects.py +++ b/release-scripts/generate_release_objects.py @@ -346,6 +346,7 @@ def setup_openai_api(env_location): categories = { "highlight": [], "enhancement": [], + "breaking-change": [], "deprecation": [], "bug": [], "documentation": [] From 61a07ecc5d27e274733f0bacbe5305c869667e07 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Tue, 18 Feb 2025 10:34:01 -0800 Subject: [PATCH 4/4] Adding the breaking-change tag to category headers --- release-scripts/generate_release_objects.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/release-scripts/generate_release_objects.py b/release-scripts/generate_release_objects.py index 57a6c5e478..b67ade140a 100644 --- a/release-scripts/generate_release_objects.py +++ b/release-scripts/generate_release_objects.py @@ -338,6 +338,7 @@ def setup_openai_api(env_location): label_to_category = { "highlight": "## Release highlights", "enhancement": "## Enhancements", + "breaking-change": "## Breaking changes", "deprecation": "## Deprecations", "bug": "## Bug fixes", "documentation": "## Documentation" @@ -900,7 +901,7 @@ def main(): setup_openai_api(env_location) print() - label_hierarchy = ["highlight", "enhancement", "deprecation", "bug", "documentation"] + label_hierarchy = ["highlight", "enhancement", "breaking-change", "deprecation", "bug", "documentation"] display_list(label_hierarchy) print()