Skip to content

Commit c032672

Browse files
[Release] v1.12.0 release tasks (#1825)
* [1.12.0][Bug][zos_mvs_raw] Bugfix/zos mvs raw verbose 1.12 (#1780) * Added fix for zos_mvs_raw verbosity false positive and hiding program return codes * Added tests for the fixes * Added changelog to be updated * Renamed changelog * Update tests/functional/modules/test_zos_mvs_raw_func.py Co-authored-by: Ketan Kelkar <[email protected]> * Update tests/functional/modules/test_zos_mvs_raw_func.py Co-authored-by: Ketan Kelkar <[email protected]> * Update tests/functional/modules/test_zos_mvs_raw_func.py Co-authored-by: Ketan Kelkar <[email protected]> * Update changelogs/fragments/1780-zos_mvs_raw-verbose-fail.yml Co-authored-by: Ketan Kelkar <[email protected]> * Update changelogs/fragments/1780-zos_mvs_raw-verbose-fail.yml Co-authored-by: Ketan Kelkar <[email protected]> * Update changelogs/fragments/1780-zos_mvs_raw-verbose-fail.yml Co-authored-by: Ketan Kelkar <[email protected]> --------- Co-authored-by: Ketan Kelkar <[email protected]> * [v1.12.0][Bug][zos_mvs_raw] Remove stdout being replaced by stderr when RC=0 and verbosity is true (#1800) * Removed stdout being replaced by stderr * Added changelog fragment * Updated changelog fragment * [zos_find] Find VSAM cluster when DISP=OLD (#1818) * Fixed not finding vsam * Added tests for finding vsam pattern * Added tests * Added fix to find data and index components * Added changelog fragments * Added fix for ansible test sanity * Modifed galaxy.yml * Modified ibm_zos_core_meta.yml * Updated README.md * Updated ansible-lint to be in sync with galaxy build_ignore * Updated support matrix * Updated summary * Updated Changelog * Updated changelog yaml * Deleted changelog fragments * Added release notes entries * Added known issue * Updated ansible-lint * Removed -e file * Fixed linting issue --------- Co-authored-by: Ketan Kelkar <[email protected]>
1 parent 2b87759 commit c032672

File tree

15 files changed

+225
-152
lines changed

15 files changed

+225
-152
lines changed

.ansible-lint

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,11 @@ exclude_paths:
3838
- tests/sanity/ignore-2.13.txt
3939
- tests/sanity/ignore-2.14.txt
4040
- venv*
41+
- ansible_collections/
4142
parseable: true
4243
quiet: false
4344
use_default_rules: true
4445
verbosity: 1
4546
# Offline mode disables installation of requirements.yml and schema refreshing often
4647
# found in project_root/collections/requirements.yml.
47-
offline: true
48+
offline: true

.github/workflows/ac-ansible-test-sanity.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ jobs:
6464
run: |
6565
source venv/venv-2.16/bin/activate
6666
python -m pip install --upgrade pip
67-
pip install ansible
67+
pip install ansible-core==2.17.6
6868
6969
- name: Run ac-sanity
7070
run: |

CHANGELOG.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ ibm.ibm\_zos\_core Release Notes
44

55
.. contents:: Topics
66

7-
v1.12.0-beta.1
8-
==============
7+
v1.12.0
8+
=======
99

1010
Release Summary
1111
---------------
1212

13-
Release Date: '2024-10-31'
13+
Release Date: '2024-12-06'
1414
This changelog describes all changes made to the modules and plugins included
1515
in this collection. The release date is the date the changelog is created.
1616
For additional details such as required dependencies and availability review
@@ -42,11 +42,16 @@ Bugfixes
4242
- zos_data_set - The ``tmp_hlq`` option was previously ignored and default values were used instead. Fix now honors the value set in the module option. (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
4343
- zos_encode - The ``tmp_hlq`` option was previously ignored and default values were used instead. Fix now honors the value set in the module option. (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
4444
- zos_fetch - The ``tmp_hlq`` option was previously ignored and default values were used instead. Fix now honors the value set in the module option. (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
45+
- zos_find - Module would not find VSAM data and index resource types. Fix now finds the data and index resource types. (https://github.com/ansible-collections/ibm_zos_core/pull/1818).
46+
- zos_find - Module would not find a VSAM cluster resource type if it was in use with DISP=OLD. Fix now finds the VSAM cluster. (https://github.com/ansible-collections/ibm_zos_core/pull/1818).
4547
- zos_job_output - RACF user names containing a ``@``, ``$``, or ``#`` raised an invalid argument error. Fix now allows the use of all valid characters for a RACF user. (https://github.com/ansible-collections/ibm_zos_core/pull/1661).
4648
- zos_job_query - Module was not returning values for system and subsystem. Fix now returns these values. (https://github.com/ansible-collections/ibm_zos_core/pull/1761).
4749
- zos_job_query - RACF user names containing a ``@``, ``$``, or ``#`` raised an invalid argument error. Fix now allows the use of all valid characters for a RACF user. (https://github.com/ansible-collections/ibm_zos_core/pull/1661).
4850
- zos_lineinfile - The ``tmp_hlq`` option was previously ignored and default values were used instead. Fix now honors the value set in the module option. (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
4951
- zos_mount - The ``tmp_hlq`` option was previously ignored and default values were used instead. Fix now honors the value set in the module option. (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
52+
- zos_mvs_raw - If a program failed with a non-zero return code and verbose was false, the module would succeed (false positive). Fix now fails the module for all instances where a program has a non-zero return code. (https://github.com/ansible-collections/ibm_zos_core/pull/1780).
53+
- zos_mvs_raw - Module would obfuscate the return code from the program when failing returning 8 instead. Fix now returns the proper return code from the program. (https://github.com/ansible-collections/ibm_zos_core/pull/1780).
54+
- zos_mvs_raw - Module would return the stderr content in stdout when verbose was true and return code was 0. Fix now does not replace stdout content with stderr. (https://github.com/ansible-collections/ibm_zos_core/pull/1800).
5055
- zos_mvs_raw - base64 sub-option for return_content under option for retrieving DD output did not return base64. Fix now returns the base64 encoded contents of the DD. (https://github.com/ansible-collections/ibm_zos_core/pull/1691).
5156
- zos_script - The module would discard command line arguments in a command, except for the first one. Fix now makes sure that all arguments are passed to the remote command that gets executed. (https://github.com/ansible-collections/ibm_zos_core/pull/1698).
5257
- zos_unarchive - The ``tmp_hlq`` option was previously ignored and default values were used instead. Fix now honors the value set in the module option. (https://github.com/ansible-collections/ibm_zos_core/pull/1695).
@@ -265,7 +270,7 @@ Bugfixes
265270
Known Issues
266271
------------
267272

268-
- Several modules have reported UTF8 decoding errors when interacting with results that contain non-printable UTF8 characters in the response. This occurs when a module receives content that does not correspond to a UTF-8 value. These include modules `zos_job_submit`, `zos_job_output`, `zos_operator_action_query` but are not limited to this list. This will be addressed in `ibm_zos_core` version 1.10.0. Each case is unique, some options to work around the error are below. - Specify that the ASA assembler option be enabled to instruct the assembler to use ANSI control characters instead of machine code control characters. - Add `ignore_errors:true` to the playbook task so the task error will not fail the playbook. - If the error is resulting from a batch job, add `ignore_errors:true` to the task and capture the output into a variable and extract the job ID with a regular expression and then use `zos_job_output` to display the DD without the non-printable character such as the DD `JESMSGLG`. (https://github.com/ansible-collections/ibm_zos_core/issues/677) (https://github.com/ansible-collections/ibm_zos_core/issues/776) (https://github.com/ansible-collections/ibm_zos_core/issues/972)
273+
- Several modules have reported UTF8 decoding errors when interacting with results that contain non-printable UTF8 characters in the response. This occurs when a module receives content that does not correspond to a UTF-8 value. These include modules `zos_job_submit`, `zos_job_output`, `zos_operator_action_query` but are not limited to this list. This will be addressed in `ibm_zos_core` version 1.10.0-beta.1. Each case is unique, some options to work around the error are below. - Specify that the ASA assembler option be enabled to instruct the assembler to use ANSI control characters instead of machine code control characters. - Add `ignore_errors:true` to the playbook task so the task error will not fail the playbook. - If the error is resulting from a batch job, add `ignore_errors:true` to the task and capture the output into a variable and extract the job ID with a regular expression and then use `zos_job_output` to display the DD without the non-printable character such as the DD `JESMSGLG`. (https://github.com/ansible-collections/ibm_zos_core/issues/677) (https://github.com/ansible-collections/ibm_zos_core/issues/776) (https://github.com/ansible-collections/ibm_zos_core/issues/972)
269274
- With later versions of `ansible-core` used with `ibm_zos_core` collection a warning has started to appear "Module "ansible.builtin.command" returned non UTF-8 data in the JSON response" that is currently being reviewed. There are no recommendations at this point. (https://github.com/ansible-collections/ibm_zos_core/issues/983)
270275

271276
New Modules

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ For Galaxy and GitHub users, to see the supported ansible-core versions, review
175175
| Version | Status | Release notes | Changelogs |
176176
|----------|----------------|---------------|------------|
177177
| 1.13.x | In development | unreleased | unreleased |
178-
| 1.12.x | Current | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-11-0) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.12.0-beta.1/CHANGELOG.rst) |
178+
| 1.12.x | Current | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-12-0) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.12.0/CHANGELOG.rst) |
179179
| 1.11.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-11-0) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.11.0/CHANGELOG.rst) |
180180
| 1.10.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-10-0) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.10.0/CHANGELOG.rst) |
181181
| 1.9.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-9-2) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.9.2/CHANGELOG.rst) |

changelogs/changelog.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,39 @@ releases:
398398
- 1631-enabler-zos_mount-special-character-support.yml
399399
- v1.11.0-beta.1_summary.yml
400400
release_date: '2024-08-05'
401+
1.12.0:
402+
changes:
403+
bugfixes:
404+
- zos_find - Module would not find VSAM data and index resource types. Fix now
405+
finds the data and index resource types. (https://github.com/ansible-collections/ibm_zos_core/pull/1818).
406+
- zos_find - Module would not find a VSAM cluster resource type if it was in
407+
use with DISP=OLD. Fix now finds the VSAM cluster. (https://github.com/ansible-collections/ibm_zos_core/pull/1818).
408+
- zos_mvs_raw - If a program failed with a non-zero return code and verbose
409+
was false, the module would succeed (false positive). Fix now fails the module
410+
for all instances where a program has a non-zero return code. (https://github.com/ansible-collections/ibm_zos_core/pull/1780).
411+
- zos_mvs_raw - Module would obfuscate the return code from the program when
412+
failing returning 8 instead. Fix now returns the proper return code from the
413+
program. (https://github.com/ansible-collections/ibm_zos_core/pull/1780).
414+
- zos_mvs_raw - Module would return the stderr content in stdout when verbose
415+
was true and return code was 0. Fix now does not replace stdout content with
416+
stderr. (https://github.com/ansible-collections/ibm_zos_core/pull/1800).
417+
release_summary: 'Release Date: ''2024-12-06''
418+
419+
This changelog describes all changes made to the modules and plugins included
420+
421+
in this collection. The release date is the date the changelog is created.
422+
423+
For additional details such as required dependencies and availability review
424+
425+
the collections `release notes <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html>`__
426+
427+
'
428+
fragments:
429+
- 1780-zos_mvs_raw-verbose-fail.yml
430+
- 1800-zos_mvs_raw-stdout-replaced-by-stderr.yml
431+
- 1818-zos_find-vsam-disp-old.yml
432+
- v1.12.0_summary.yml
433+
release_date: '2024-12-04'
401434
1.12.0-beta.1:
402435
changes:
403436
bugfixes:

docs/source/release_notes.rst

Lines changed: 88 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
Releases
77
========
88

9-
Version 1.12.0-beta.1
10-
=====================
9+
Version 1.12.0
10+
==============
1111

1212
Minor Changes
1313
-------------
@@ -54,6 +54,11 @@ Bugfixes
5454

5555
- ``zos_fetch`` - module option **tmp_hlq** was previously ignored and default values were used. Now the module uses the value set in the option.
5656

57+
- ``zos_find``
58+
59+
- Module would not find VSAM data and index resource types. Fix now finds the data and index resource types.
60+
- Module would not find a VSAM cluster resource type if it was in use with DISP=OLD. Fix now finds the VSAM cluster.
61+
5762
- ``zos_job_output`` - module would raise an invalid argument error for a user ID that contained **@**, **$**, or **#**. Now the module supports RACF user naming conventions.
5863

5964
- ``zos_job_query``
@@ -65,7 +70,12 @@ Bugfixes
6570

6671
- ``zos_mount`` - module option **tmp_hlq** was previously ignored and default values were used. Now the module uses the value set in the option.
6772

68-
- ``zos_mvs_raw`` - module sub-option **base64** for **return_content** did not retrieve DD output as Base64. Now the module returns Base64 encoded contents for the DD.
73+
- ``zos_mvs_raw``
74+
75+
- Module sub-option **base64** for **return_content** did not retrieve DD output as Base64. Now the module returns Base64 encoded contents for the DD.
76+
- Module would return the stderr content in stdout when verbose was true and return code was 0. Fix now does not replace stdout content with stderr.
77+
- Module would obfuscate the return code from the program when failing returning 8 instead. Fix now returns the proper return code from the program.
78+
- If a program failed with a non-zero return code and verbose was false, the module would succeed (false positive). Fix now fails the module for all instances where a program has a non-zero return code.
6979

7080
- ``zos_script`` - module would only read the first command line argument if more than one was used. Now the module passes all arguments to the remote command.
7181

@@ -74,6 +84,7 @@ Bugfixes
7484
Availability
7585
------------
7686

87+
* `Automation Hub`_
7788
* `Galaxy`_
7889
* `GitHub`_
7990

@@ -88,6 +99,39 @@ Known Issues
8899
- ``zos_job_submit`` - when setting 'location' to 'local' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
89100
- ``zos_job_submit`` - when submitting JCL, the response value returned for **byte_count** is incorrect.
90101
- ``zos_apf`` - When trying to remove a library that contains the '$' character in the name for an APF(authorized program facility), the operation will fail.
102+
- ``zos_find`` - When trying to find a VSAM data set that is allocated with DISP=OLD using age filter the module will not find it.
103+
104+
Version 1.11.1
105+
==============
106+
107+
Bugfixes
108+
--------
109+
110+
- ``zos_mvs_raw``
111+
112+
- If a program failed with a non-zero return code and verbose was false, the module would succeed. Whereas, if the program failed and verbose was true the module would fail(false positive). Fix now has a consistent behavior and fails in both cases.
113+
- Module would obfuscate the return code from the program when failing returning 8 instead. Fix now returns the proper return code from the program.
114+
- Module would return the stderr content in stdout when verbose was true and return code was 0. Fix now does not replace stdout content with stderr.
115+
116+
117+
Availability
118+
------------
119+
120+
* `Automation Hub`_
121+
* `Galaxy`_
122+
* `GitHub`_
123+
124+
Requirements
125+
------------
126+
127+
The IBM z/OS core collection has several dependencies, please review the `z/OS core support matrix`_ to understand both the
128+
control node and z/OS managed node dependencies.
129+
130+
Known Issues
131+
------------
132+
- ``zos_job_submit`` - when setting 'location' to 'local' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
133+
- ``zos_job_submit`` - when submitting JCL, the response value returned for **byte_count** is incorrect.
134+
- ``zos_apf`` - When trying to remove a library that contains the '$' character in the name from APF(authorized program facility), operation will fail.
91135

92136
Version 1.11.0
93137
==============
@@ -313,6 +357,47 @@ Known Issues
313357
- In the past, choices could be defined in either lower or upper case. Now, only the case that is identified in the docs can be set, this is so that the collection can continue to maintain certified status.
314358
- Use of special characters (#, @, $, \- ) in different options like data set names and commands is not fully supported, some modules support them but is the user responsibility to escape them. Read each module documentation for further details.
315359

360+
Version 1.9.4
361+
=============
362+
363+
Bugfixes
364+
--------
365+
366+
- ``zos_mvs_raw`` - If verbose was true, even if the program return code was 0, the module would fail. Fix now ensures the module fails on non-zero return code only.
367+
368+
Availability
369+
------------
370+
371+
* `Automation Hub`_
372+
* `Galaxy`_
373+
* `GitHub`_
374+
375+
Requirements
376+
------------
377+
378+
The IBM z/OS core collection has several dependencies, please review the `z/OS core support matrix`_ to understand both the
379+
controller and z/OS managed node dependencies.
380+
381+
Known Issues
382+
------------
383+
384+
- ``zos_job_submit`` - when setting 'location' to 'LOCAL' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
385+
- ``zos_job_submit`` - when submitting JCL, the response value returned for **byte_count** is incorrect.
386+
387+
- ``zos_job_submit``, ``zos_job_output``, ``zos_operator_action_query`` - encounters UTF-8 decoding errors when interacting with results that contain non-printable UTF-8 characters in the response. This has been addressed in this release and corrected with **ZOAU version 1.2.5.6** or later.
388+
389+
- If the appropriate level of ZOAU can not be installed, some options are to:
390+
391+
- Specify that the ASA assembler option be enabled to instruct the assembler to use ANSI control characters instead of machine code control characters.
392+
- Ignore module errors by using **ignore_errors:true** for a specific playbook task.
393+
- If the error is resulting from a batch job, add **ignore_errors:true** to the task and capture the output into a registered variable to extract the
394+
job ID with a regular expression. Then use ``zos_job_output`` to display the DD without the non-printable character such as the DD **JESMSGLG**.
395+
- If the error is the result of a batch job, set option **return_output** to false so that no DDs are read which could contain the non-printable UTF-8 characters.
396+
397+
- ``zos_data_set`` - An undocumented option **size** was defined in module **zos_data_set**, this has been removed to satisfy collection certification, use the intended and documented **space_primary** option.
398+
399+
- In the past, choices could be defined in either lower or upper case. Now, only the case that is identified in the docs can be set, this is so that the collection can continue to maintain certified status.
400+
316401
Version 1.9.3
317402
=============
318403

docs/source/resources/releases_maintenance.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The z/OS managed node includes several shells, currently the only supported shel
8989
+---------+----------------------------+---------------------------------------------------+---------------+---------------+
9090
| Version | Controller | Managed Node | GA | End of Life |
9191
+=========+============================+===================================================+===============+===============+
92-
| 1.12.x |- `ansible-core`_ >=2.15.x |- `z/OS`_ V2R4 - V3Rx | TBD | TBD |
92+
| 1.12.x |- `ansible-core`_ >=2.15.x |- `z/OS`_ V2R4 - V3Rx | 6 Dec 2024 | 6 Dec 2026 |
9393
| |- `Ansible`_ >=8.0.x |- `z/OS shell`_ | | |
9494
| |- `AAP`_ >=2.4 |- IBM `Open Enterprise SDK for Python`_ | | |
9595
| | |- IBM `Z Open Automation Utilities`_ >=1.3.2 | | |
@@ -162,4 +162,4 @@ The z/OS managed node includes several shells, currently the only supported shel
162162
.. _Ansible:
163163
https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix
164164
.. _/bin/sh:
165-
https://www.ibm.com/docs/en/zos/3.1.0?topic=descriptions-sh-invoke-shell
165+
https://www.ibm.com/docs/en/zos/3.1.0?topic=descriptions-sh-invoke-shell

galaxy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ namespace: ibm
66
name: ibm_zos_core
77

88
# The collection version
9-
version: "1.12.0-beta.1"
9+
version: "1.12.0"
1010

1111
# Collection README file
1212
readme: README.md

meta/ibm_zos_core_meta.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: ibm_zos_core
2-
version: "1.12.0-beta.1"
2+
version: "1.12.0"
33
managed_requirements:
44
-
55
name: "IBM Open Enterprise SDK for Python"

0 commit comments

Comments
 (0)