+ breaking-change releases tag, PR template, & release script update

[validbeck]

Internal Notes for Reviewers

sc-8459

breaking-change release tag

Added to:

• documentation
• validmind-library
• frontend

PR templates

Added the instructions for the breaking-change label to:

• documentation:
  

  documentation/.github/pull_request_template.md

  Line 11 in 61a07ec

  - `breaking-change`

• validmind-library: +breaking-changes tag to PR template validmind-library#318
• frontend: https://github.com/validmind/frontend/pull/1234

Generate release script & notebook

Updated both of these to include the breaking-change > ## Breaking changes label to header in the hierarchy:

generate_release_objects.py

Setting up the object for the categories based on PR labels:

documentation/release-scripts/generate_release_objects.py

Line 350 in 61a07ec

"breaking-change": [],

Transforming the label to the header category:

documentation/release-scripts/generate_release_objects.py

Line 341 in 61a07ec

"breaking-change": "## Breaking changes",

Setting the label hierarchy in main for when the script is called via Make:

documentation/release-scripts/generate_release_objects.py

Line 904 in 61a07ec

label_hierarchy = ["highlight", "enhancement", "breaking-change", "deprecation", "bug", "documentation"]

generate-release-notes.ipynb

Default label hierarchy when the notebook is run:

documentation/release-scripts/generate-release-notes.ipynb

Line 158 in 61a07ec

"label_hierarchy = [\"highlight\", \"enhancement\", \"breaking-change\", \"deprecation\", \"bug\", \"documentation\"]\n",

Other

• Removed references to the blog post column in the breaking changes/deprecations README as we decided to omit that from the table.
• Updated the release notes for January 26, 2024 to separate out the breaking change from the deprecations to keep things uniform going forward: LIVE PREVIEW

[github-actions]

PR Summary

This pull request introduces the 'breaking-change' label to the release notes generation process. The changes include:

• Updating the pull request template to include 'breaking-change' as a label option.
• Modifying the release notes generation script to recognize 'breaking-change' as a category, ensuring it is included in the label hierarchy and category lists.
• Updating the release highlights documentation to include a new section for 'Breaking changes', specifically detailing the removal of deprecated high-level API methods run_template and run_test_plan.
• Adjusting the README for breaking changes to remove the requirement for a blog post link, focusing solely on release notes links.

These changes ensure that breaking changes are properly categorized and documented in the release notes, providing clear guidance for users on necessary code updates.

Test Suggestions

• Verify that the 'breaking-change' label is correctly added to the pull request template.
• Test the release notes generation script to ensure 'breaking-change' is included in the output.
• Check that the documentation correctly reflects the new 'Breaking changes' section and accurately describes the removed API methods.
• Ensure that the README updates are correctly reflected and that the process for documenting breaking changes is clear.

[nrichers]

LGTM (looks GREAT to me)! 🚀 🚀 🚀