^^^^^^^^^^^^^^
This version contains all fixes up to version 1.13.4.
Released: 2024-02-17
**Incompatible changes:**
* The incompatibility caused by the recent change to support regular expression
matching for the resource name in the 'find()' method, which was released in
zhmcclient versions 1.12.3 and 1.13.0, turned out to be too heavy. The change
is now undone to go back to string comparison for the name matching in
'find()'. The 'findall()' method which was also changed in these releases
keeps the regular expression matching for consistency with 'list()'.
(issue 1395)
**Bug fixes:**
* Docs: Increased minimum Sphinx versions to 7.1.0 on Python 3.8 and to 7.2.0 on
Python >=3.9 and adjusted dependent package versions in order to fix a version
incompatibility between sphinxcontrib-applehelp and Sphinx.
Disabled Sphinx runs on Python <=3.7 in order to no longer having to deal
with older Sphinx versions. (issue 1396)
* Changed the recently released support for regular expression matching for the
resource name in 'find()' back to matching by string comparison. The
'findall()' method keeps the regular expression matching for consistency
with 'list()'. (issue 1395)
* Fixed that the resource name in the filter arguments of 'findall()' and
'list()' was not matched case insensitvely with regular expressions for the
resource types that have case insensitive names (user, user pattern, password
rule, LDAP server definition). (related to issue 1395)
* Fixed that 'Console.list_permitted_lpars()' ignored the
'additional_properties' parameter. (issue 1410)
* Test: Fixed that unit tests did not properly check missing properties in
the returned resources. (related to issue 1410)
* Fixed that 'list()' methods returned only a minimal set of properties
for each resource when the resource was found in the name-to-URI cache,
and in that case missed some properties that are documented for the
corresponding HMC list operation. This was fixed by removing the optimization
of using the name-to-URI cache in 'list()' methods. (related to issue 1410)
* In the zhmcclient mock support, fixed the processing of the
'additional-properties' query parameters for the mock support of the following
zhmcclient list methods: 'Console.list_permitted_lpars()',
'Cpc.adapters.list()', 'Cpc.partitions.list()', 'Cpc.virtual_switches.list()',
'Cpc.image_activation_profiles.list()'. (related to issue 1410)
* Development: Fixed dependency issue with safety 3.0.0 by pinning it.
* Performance: In zhmcclient version 1.13.0, an optimization was added where
list() and find_local() were now utilizing the name-to-URI cache when only the
resource name was specified as a filter argument. This caused the 'se-version'
property to no longer be in the local zhmcclient.Cpc objects that were used
as the parent objects of the Lpar/Partition objects returned by
Console.list_permitted_lpars/partitions() and caused a performance
degradation in the zhmc_lpar_list and zhmc_partition_list Ansible modules due
to repeated "Get CPC Properties" operations for retrieving the 'se-version'
property. This was fixed in the Console.list_permitted_lpars/partitions()
methods.
* Fixed the call to pipdeptree in the test workflow to use 'python -m'
because otherwise it does not show the correct packages of the virtual env.
* Fixed the 'Cpc.delete_retrieved_internal_code()' method which passed its
'ec_level' parameter incorrectly to the HMC operation. Added unit tests.
(issue 1432)
**Enhancements:**
* Test: Added Python 3.8 with latest package levels to normal tests because
that is now the minimum version to run Sphinx. (related to issue 1396)
* Added support for a new make target 'authors' that generates an AUTHORS.md
file from the git commit history. Added the invocation of 'make authors' to
the description of how to release a version in the development
documentation. (issue 1393)
* In Console.list_permitted_lpars/partitions(), added CPC-related properties
to the returned resource objects, that are returned by the HMC: 'cpc-name',
'cpc-object-uri', 'se-version'. (issue 1421)
* In Console.list_permitted_lpars(), the additional_properties parameter
is now supported also for HMC versions older than 2.16 GA 1.5. In that
case, the zhmcclient handles adding the properties. (related to issue 1421)
* The pull_full_properties() and pull_properties() methods of zhmcclient
resource objects no longer replace existing properties but now update them,
so that additionally present properties (e.g. the CPC-related properties
returned from Console.list_permitted_lpars/partitions()) are preserved.
(related to issue 1421)
**Cleanup:**
* Increased versions of GitHub Actions plugins to increase node.js runtime
to version 20.