From 5401f03c8777c3e49381c6e8d653a08165794dee Mon Sep 17 00:00:00 2001 From: Andreas Maier Date: Tue, 8 Oct 2024 20:57:12 +0200 Subject: [PATCH] Release 1.18.0 Signed-off-by: Andreas Maier --- changes/1505.feature.rst | 1 - changes/1506.feature.rst | 1 - changes/1543.feature.rst | 2 - changes/1543.fix.rst | 5 -- changes/1611.fix.rst | 1 - changes/1660.fix.rst | 1 - changes/1665.fix.rst | 3 - changes/618.feature.2.rst | 4 -- changes/618.feature.rst | 5 -- changes/noissue.1.18.0.notshown.rst | 1 - changes/noissue.1.cleanup.rst | 1 - changes/noissue.1.feature.rst | 1 - changes/noissue.1.fix.rst | 5 -- changes/noissue.1.incompatible.rst | 3 - changes/noissue.2.cleanup.rst | 2 - changes/noissue.2.feature.rst | 1 - changes/noissue.2.fix.rst | 1 - changes/noissue.3.cleanup.rst | 5 -- changes/noissue.3.feature.rst | 1 - changes/noissue.3.fix.rst | 2 - changes/noissue.4.cleanup.rst | 2 - changes/noissue.5.cleanup.rst | 2 - changes/noissue.6.cleanup.rst | 2 - changes/noissue.safety.fix.rst | 1 - docs/changes.rst | 89 +++++++++++++++++++++++++++++ 25 files changed, 89 insertions(+), 53 deletions(-) delete mode 100644 changes/1505.feature.rst delete mode 100644 changes/1506.feature.rst delete mode 100644 changes/1543.feature.rst delete mode 100644 changes/1543.fix.rst delete mode 100644 changes/1611.fix.rst delete mode 100644 changes/1660.fix.rst delete mode 100644 changes/1665.fix.rst delete mode 100644 changes/618.feature.2.rst delete mode 100644 changes/618.feature.rst delete mode 100644 changes/noissue.1.18.0.notshown.rst delete mode 100644 changes/noissue.1.cleanup.rst delete mode 100644 changes/noissue.1.feature.rst delete mode 100644 changes/noissue.1.fix.rst delete mode 100644 changes/noissue.1.incompatible.rst delete mode 100644 changes/noissue.2.cleanup.rst delete mode 100644 changes/noissue.2.feature.rst delete mode 100644 changes/noissue.2.fix.rst delete mode 100644 changes/noissue.3.cleanup.rst delete mode 100644 changes/noissue.3.feature.rst delete mode 100644 changes/noissue.3.fix.rst delete mode 100644 changes/noissue.4.cleanup.rst delete mode 100644 changes/noissue.5.cleanup.rst delete mode 100644 changes/noissue.6.cleanup.rst delete mode 100644 changes/noissue.safety.fix.rst diff --git a/changes/1505.feature.rst b/changes/1505.feature.rst deleted file mode 100644 index 2a41b2f0..00000000 --- a/changes/1505.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Test: Added tests for Python 3.13 (rc.1). diff --git a/changes/1506.feature.rst b/changes/1506.feature.rst deleted file mode 100644 index 4a9cd8c2..00000000 --- a/changes/1506.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Test: Added tests for Python 3.13 (final version). diff --git a/changes/1543.feature.rst b/changes/1543.feature.rst deleted file mode 100644 index af6b6ea4..00000000 --- a/changes/1543.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Docs: Documented HMC/SE version requirements and improved the description of -firmware and API features. diff --git a/changes/1543.fix.rst b/changes/1543.fix.rst deleted file mode 100644 index 2ba9330b..00000000 --- a/changes/1543.fix.rst +++ /dev/null @@ -1,5 +0,0 @@ -Docs: Fixed the description of the 'Cpc.list_associated_storage_groups()' -method; it previously had stated that when the "dpm-storage-management" firmware -feature is not enabled, the method would be returning an empty list. That was -corrected in the documentation to match the actual behavior, which is to -fail. diff --git a/changes/1611.fix.rst b/changes/1611.fix.rst deleted file mode 100644 index 5a4e97a9..00000000 --- a/changes/1611.fix.rst +++ /dev/null @@ -1 +0,0 @@ -Docs: Fixed an RTD build issue that lead to not showing any API documentation. diff --git a/changes/1660.fix.rst b/changes/1660.fix.rst deleted file mode 100644 index 25cebe78..00000000 --- a/changes/1660.fix.rst +++ /dev/null @@ -1 +0,0 @@ -Circumvented an issue with pytz by excluding pytz version 2024.2. diff --git a/changes/1665.fix.rst b/changes/1665.fix.rst deleted file mode 100644 index 139bddef..00000000 --- a/changes/1665.fix.rst +++ /dev/null @@ -1,3 +0,0 @@ -Test: Fixed the issue that coveralls was not found in the test workflow on MacOS -with Python 3.9-3.11, by running it without login shell. Added Python 3.11 on -MacOS to the normal tests. diff --git a/changes/618.feature.2.rst b/changes/618.feature.2.rst deleted file mode 100644 index 2334c4e0..00000000 --- a/changes/618.feature.2.rst +++ /dev/null @@ -1,4 +0,0 @@ -Added support for encapsulating the interactions with an OS console through -the WebSocket protocol, by adding a new 'zhmcclient.OSConsole' class. This -builds on top of the new support for OS console access through the -WebSocket protocol. diff --git a/changes/618.feature.rst b/changes/618.feature.rst deleted file mode 100644 index e18a4744..00000000 --- a/changes/618.feature.rst +++ /dev/null @@ -1,5 +0,0 @@ -Added support for using the integrated ASCII console of operating systems -running in partitions in DPM mode via the WebSocket protocol, by adding a new -method 'zhmcclient.Partition.create_os_websocket()'. -Added a new documentation section "Using WebSocket to access OS console" that -documents how to interact with the integrated ASCII console from Python code. diff --git a/changes/noissue.1.18.0.notshown.rst b/changes/noissue.1.18.0.notshown.rst deleted file mode 100644 index 01b59593..00000000 --- a/changes/noissue.1.18.0.notshown.rst +++ /dev/null @@ -1 +0,0 @@ -Dummy change for starting new version 1.18.0 diff --git a/changes/noissue.1.cleanup.rst b/changes/noissue.1.cleanup.rst deleted file mode 100644 index d84e1901..00000000 --- a/changes/noissue.1.cleanup.rst +++ /dev/null @@ -1 +0,0 @@ -Docs: Simplified version retrieval in docs build by using setuptools_scm. diff --git a/changes/noissue.1.feature.rst b/changes/noissue.1.feature.rst deleted file mode 100644 index eb834160..00000000 --- a/changes/noissue.1.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Test: Added unit tests for exceptions that did not have one. diff --git a/changes/noissue.1.fix.rst b/changes/noissue.1.fix.rst deleted file mode 100644 index a4d9fd72..00000000 --- a/changes/noissue.1.fix.rst +++ /dev/null @@ -1,5 +0,0 @@ -Fixed installation errors on Python 3.13 by increasing the minimum versions of -install dependencies PyYAML to 6.0.2, pyrsistent to 0.20.0 and wheel to 0.41.3. -This was done for all Python versions, to simplify dependencies. -Increased the minimum versions of some development dependencies for the same -reason. diff --git a/changes/noissue.1.incompatible.rst b/changes/noissue.1.incompatible.rst deleted file mode 100644 index f578e80c..00000000 --- a/changes/noissue.1.incompatible.rst +++ /dev/null @@ -1,3 +0,0 @@ -Dev: Changed the installation of the zhmcclient package that is done in -'make install' from being editable to being non-editable, since pip will stop -supporting editable installs. diff --git a/changes/noissue.2.cleanup.rst b/changes/noissue.2.cleanup.rst deleted file mode 100644 index 24ea66b0..00000000 --- a/changes/noissue.2.cleanup.rst +++ /dev/null @@ -1,2 +0,0 @@ -Test: Increased minimum version of pylint to 3.0.1 to address an issue -when importing setuptools_scm in conf.py. diff --git a/changes/noissue.2.feature.rst b/changes/noissue.2.feature.rst deleted file mode 100644 index 327f27c5..00000000 --- a/changes/noissue.2.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed a missing closing parenthesis in MetricsResourceNotFound.__repr__(). diff --git a/changes/noissue.2.fix.rst b/changes/noissue.2.fix.rst deleted file mode 100644 index b6114fa9..00000000 --- a/changes/noissue.2.fix.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed new issue 'too-many-positional-arguments' reported by Pylint 3.3.0. diff --git a/changes/noissue.3.cleanup.rst b/changes/noissue.3.cleanup.rst deleted file mode 100644 index 3a9709df..00000000 --- a/changes/noissue.3.cleanup.rst +++ /dev/null @@ -1,5 +0,0 @@ -Dev: Relaxed the conditions when safety issues are tolerated: -Issues in development dependencies are now tolerated in normal and scheduled -test workflow runs (but not in local make runs and release test workflow runs). -Issues in installation dependencies are now tolerated in normal test workflow -runs (but not in local make runs and scheduled/release test workflow runs). diff --git a/changes/noissue.3.feature.rst b/changes/noissue.3.feature.rst deleted file mode 100644 index c768bc7f..00000000 --- a/changes/noissue.3.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Test: Improved end2end test for 'Console.list_permitted_adapters()'. diff --git a/changes/noissue.3.fix.rst b/changes/noissue.3.fix.rst deleted file mode 100644 index 7ee1347b..00000000 --- a/changes/noissue.3.fix.rst +++ /dev/null @@ -1,2 +0,0 @@ -Fixed dependabot issue #25. This caused the minimum version of the -'jsonschema' package to be increased to 4.18.0. diff --git a/changes/noissue.4.cleanup.rst b/changes/noissue.4.cleanup.rst deleted file mode 100644 index a8311fc3..00000000 --- a/changes/noissue.4.cleanup.rst +++ /dev/null @@ -1,2 +0,0 @@ -Dev: Added to the release instructions to roll back fixes for safety issues -into any maintained stable branches. diff --git a/changes/noissue.5.cleanup.rst b/changes/noissue.5.cleanup.rst deleted file mode 100644 index 6cf5d917..00000000 --- a/changes/noissue.5.cleanup.rst +++ /dev/null @@ -1,2 +0,0 @@ -Dev: Added to the release instructions to check and fix dependabot issues, -and to roll back any fixes into any maintained stable branches. diff --git a/changes/noissue.6.cleanup.rst b/changes/noissue.6.cleanup.rst deleted file mode 100644 index 8ae0388d..00000000 --- a/changes/noissue.6.cleanup.rst +++ /dev/null @@ -1,2 +0,0 @@ -Docs: Clarified descriptions of the 'feature_enabled()' and -'feature_info()' methods of classes 'Partition' and 'Cpc'. diff --git a/changes/noissue.safety.fix.rst b/changes/noissue.safety.fix.rst deleted file mode 100644 index 1798e2be..00000000 --- a/changes/noissue.safety.fix.rst +++ /dev/null @@ -1 +0,0 @@ -Addressed safety issues up to 2024-08-18. diff --git a/docs/changes.rst b/docs/changes.rst index 50b26229..2dc354b2 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -20,6 +20,95 @@ Change log ---------- .. towncrier start +Version 1.18.0 +^^^^^^^^^^^^^^ + +Released: 2024-10-08 + +**Incompatible changes:** + +* Dev: Changed the installation of the zhmcclient package that is done in + 'make install' from being editable to being non-editable, since pip will stop + supporting editable installs. + +**Bug fixes:** + +* Addressed safety issues up to 2024-08-18. + +* Fixed installation errors on Python 3.13 by increasing the minimum versions of + install dependencies PyYAML to 6.0.2, pyrsistent to 0.20.0 and wheel to 0.41.3. + This was done for all Python versions, to simplify dependencies. + Increased the minimum versions of some development dependencies for the same + reason. + +* Fixed new issue 'too-many-positional-arguments' reported by Pylint 3.3.0. + +* Fixed dependabot issue #25. This caused the minimum version of the + 'jsonschema' package to be increased to 4.18.0. + +* Docs: Fixed the description of the 'Cpc.list_associated_storage_groups()' + method; it previously had stated that when the "dpm-storage-management" firmware + feature is not enabled, the method would be returning an empty list. That was + corrected in the documentation to match the actual behavior, which is to + fail. (`#1543 `_) + +* Docs: Fixed an RTD build issue that lead to not showing any API documentation. (`#1611 `_) + +* Circumvented an issue with pytz by excluding pytz version 2024.2. (`#1660 `_) + +* Test: Fixed the issue that coveralls was not found in the test workflow on MacOS + with Python 3.9-3.11, by running it without login shell. Added Python 3.11 on + MacOS to the normal tests. (`#1665 `_) + +**Enhancements:** + +* Test: Added unit tests for exceptions that did not have one. + +* Fixed a missing closing parenthesis in MetricsResourceNotFound.__repr__(). + +* Test: Improved end2end test for 'Console.list_permitted_adapters()'. + +* Added support for encapsulating the interactions with an OS console through + the WebSocket protocol, by adding a new 'zhmcclient.OSConsole' class. This + builds on top of the new support for OS console access through the + WebSocket protocol. (`#618 `_) + +* Added support for using the integrated ASCII console of operating systems + running in partitions in DPM mode via the WebSocket protocol, by adding a new + method 'zhmcclient.Partition.create_os_websocket()'. + Added a new documentation section "Using WebSocket to access OS console" that + documents how to interact with the integrated ASCII console from Python code. (`#618 `_) + +* Test: Added tests for Python 3.13 (rc.1). (`#1505 `_) + +* Test: Added tests for Python 3.13 (final version). (`#1506 `_) + +* Docs: Documented HMC/SE version requirements and improved the description of + firmware and API features. (`#1543 `_) + +**Cleanup:** + +* Docs: Simplified version retrieval in docs build by using setuptools_scm. + +* Test: Increased minimum version of pylint to 3.0.1 to address an issue + when importing setuptools_scm in conf.py. + +* Dev: Relaxed the conditions when safety issues are tolerated: + Issues in development dependencies are now tolerated in normal and scheduled + test workflow runs (but not in local make runs and release test workflow runs). + Issues in installation dependencies are now tolerated in normal test workflow + runs (but not in local make runs and scheduled/release test workflow runs). + +* Dev: Added to the release instructions to roll back fixes for safety issues + into any maintained stable branches. + +* Dev: Added to the release instructions to check and fix dependabot issues, + and to roll back any fixes into any maintained stable branches. + +* Docs: Clarified descriptions of the 'feature_enabled()' and + 'feature_info()' methods of classes 'Partition' and 'Cpc'. + + Version 1.17.0 ^^^^^^^^^^^^^^