Update meta data and docs for 1.5.0-beta.1 release tasks (#650)

* Update meta files for release 1.5.0-beta.1

Signed-off-by: ddimatos <[email protected]>

* Words matter initiative

Signed-off-by: ddimatos <[email protected]>

* Add changelog fragment

Signed-off-by: ddimatos <[email protected]>

* Remove unicode text in our docs

Signed-off-by: ddimatos <[email protected]>

* Update release notes with changes that are included in the release

Signed-off-by: ddimatos <[email protected]>

* Update module doc after removeing the unicode text

Signed-off-by: ddimatos <[email protected]>

* Correct spelling

Signed-off-by: ddimatos <[email protected]>

---------

Signed-off-by: ddimatos <[email protected]>

Author: ddimatos

CHANGELOG.rst

@@ -46,8 +46,6 @@ Minor Changes
 - zos_job_submit - The architecture changed such that the entire modules execution time now captured in the duration time which includes job submission and log collection. If a job does not return by the default 10 sec 'wait_time_s' value, it can be increased up to 86400 seconds. (https://github.com/ansible-collections/ibm_zos_core/issues/389).
 - zos_job_submit - behavior changed when a volume is defined in the module options such that it will catalog the data set if it is not cataloged and submit the job. In the past, the function did not catalog the data set and instead performed I/O operations and then submitted the job. This behavior aligns to other module behaviors and reduces the possibility to encounter a permissions issue. (https://github.com/ansible-collections/ibm_zos_core/issues/389).
 - zos_job_submit - was updated to include an additional error code condition JCLERR. (https://github.com/ansible-collections/ibm_zos_core/pull/312)
-- zos_job_submit - updates the module to correct the modules behavior such that the max_rc can declare if the module should fail when a non-zero return code is received.  (https://github.com/ansible-collections/ibm_zos_core/pull/552).
-- zos_job_submit - updates the module to not return a JCL ERROR code as a return code. JCL ERRORs are not return codes to be returned as part of the ret_code dictionary.  (https://github.com/ansible-collections/ibm_zos_core/pull/552).
 - zos_lineinfile - updates the module with a new option named tmp_hlq. This allows for a user to specify the data set high level qualifier (HLQ) used in any temporary data set created by the module. Often, the defaults are not permitted on systems, this provides a way to override the defaults. (https://github.com/ansible-collections/ibm_zos_core/pull/341).
 - zos_mount - updates the module with a new option named tmp_hlq. This allows for a user to specify the data set high level qualifier (HLQ) used in any temporary data set created by the module. Often, the defaults are not permitted on systems, this provides a way to override the defaults. (https://github.com/ansible-collections/ibm_zos_core/pull/341).
 - zos_mvs_raw - Ensures that temporary datasets created by DD Statements use the tmp_hlq specified. This allows for a user to specify the data set high level qualifier (HLQ) used in any temporary data set created by the module. Often, the defaults are not permitted on systems, this provides a way to override the defaults. (https://github.com/ansible-collections/ibm_zos_core/pull/414).
@@ -69,16 +67,21 @@ Bugfixes
 --------
 
 - zos_copy - Fixes a bug such that the module fails when copying files from a directory needing also to be encoded. The failure would also delete the `src` which was not desirable behavior. Fixes deletion of src on encoding error. (https://github.com/ansible-collections/ibm_zos_core/pull/321).
+- zos_copy - Fixes wrongful creation of destination backups when module option `force` is true, creating emergency backups meant to restore the system to its initial state in case of a module failure only when force is false. (https://github.com/ansible-collections/ibm_zos_core/pull/590)
+- zos_copy - Fixes a bug where copying a member from a loadlib to another loadlib fails. (https://github.com/ansible-collections/ibm_zos_core/pull/640)
+- zos_copy - Fixes a bug where if a destination has accented characters in its content, the module would fail when trying to determine if it is empty. (https://github.com/ansible-collections/ibm_zos_core/pull/634)
+- zos_copy - Fixes a bug where the computed record length for a new destination dataset would include newline characters. (https://github.com/ansible-collections/ibm_zos_core/pull/620)
 - zos_copy - module was updated to correct a bug in the case when the destination (dest) is a PDSE and the source (src) is a Unix Systems File (USS). The module would fail in determining if the PDSE actually existed and try to create it when it already existed resulting in an error that would prevent the module from correctly executing. (https://github.com/ansible-collections/ibm_zos_core/pull/327)
 - zos_data_set - Fixes a bug such that the module will delete a catalogued data set over an uncatalogued data set even though the volume is provided for the uncataloged data set. This is unexpected behavior and does not align to documentation; correct behavior is that when a volume is provided that is the first place the module should look for the data set, whether or not it is cataloged. (https://github.com/ansible-collections/ibm_zos_core/pull/325).
+- zos_data_set - Fixes a bug where the default record format FB was actually never enforced and when enforced it would cause VSAM creation to fail with a Dynalloc failure. This also cleans up some of the options that are set by default when they have no bearing for batch. (https://github.com/ansible-collections/ibm_zos_core/pull/647)
 - zos_fetch - Updates the modules behavior when fetching VSAM data sets such that the maximum record length is now determined when creating a temporary data set to copy the VSAM data into and a variable-length (VB) data set is used. (https://github.com/ansible-collections/ibm_zos_core/pull/350)
-- zos_job_output - fixes a bug that returned all ddname's when a specific ddnamae was provided. Now a specific ddname can be returned and all others ignored. (https://github.com/ansible-collections/ibm_zos_core/pull/334)
+- zos_job_output - Fixes a bug that returned all ddname's when a specific ddnamae was provided. Now a specific ddname can be returned and all others ignored. (https://github.com/ansible-collections/ibm_zos_core/pull/334)
 - zos_job_query - was updated to correct a boolean condition that always evaluated to "CANCELLED". (https://github.com/ansible-collections/ibm_zos_core/pull/312).
-- zos_mount - fixed option `tag_ccsid` to correctly allow for type int. (https://github.com/ansible-collections/ibm_zos_core/pull/511)
+- zos_mount - Fixes option `tag_ccsid` to correctly allow for type int. (https://github.com/ansible-collections/ibm_zos_core/pull/511)
 - zos_mvs_raw - module was updated to correct a bug when no DD statements were provided. The module when no option was provided for `dds` would error, a default was provided to correct this behavior. (https://github.com/ansible-collections/ibm_zos_core/pull/336)
-- zos_operator - fixed case sensitive error checks, invalid, error & unidentifiable (https://github.com/ansible-collections/ibm_zos_core/issues/389).
-- zos_operator - fixed such that specifying wait_time_s would throw an error (https://github.com/ansible-collections/ibm_zos_core/issues/389).
-- zos_operator - fixed the wait_time_s to default to 1 second (https://github.com/ansible-collections/ibm_zos_core/issues/389).
+- zos_operator - Fixes case sensitive error checks, invalid, error & unidentifiable (https://github.com/ansible-collections/ibm_zos_core/issues/389).
+- zos_operator - Fixes such that specifying wait_time_s would throw an error (https://github.com/ansible-collections/ibm_zos_core/issues/389).
+- zos_operator - Fixes the wait_time_s to default to 1 second (https://github.com/ansible-collections/ibm_zos_core/issues/389).
 - zos_operator - was updated to correct missing verbosity content when the option verbose was set to True. zos_operator - was updated to correct the trailing lines that would appear in the result content. (https://github.com/ansible-collections/ibm_zos_core/pull/400).
 
 New Modules

README.md

@@ -12,7 +12,7 @@ executing operator commands, executing TSO commands, ping,
 querying operator actions, APF authorizing libraries,
 editing textual data in data sets or Unix System Services files,
 finding data sets, backing up and restoring data sets and
-volumes and running z/OS programs without JCL.
+volumes, mounting file systems and running z/OS programs without JCL.
 
 
 Red Hat Ansible Certified Content for IBM Z
@@ -28,7 +28,7 @@ one easy-to-use platform.
 The **IBM z/OS core collection** is following the
 **Red Hat® Ansible Certified Content for IBM Z®** method of distributing
 content. Collections will be developed in the open, and when content is ready
-for use it is released to
+for use, it is released to
 [Ansible Galaxy](https://galaxy.ansible.com/search?keywords=zos_&order_by=-relevance&deprecated=false&type=collection&page=1)
 for community adoption. Once contributors review community usage, feedback,
 and are satisfied with the content published, the collection will then be

changelogs/changelog.yaml

@@ -385,6 +385,15 @@ releases:
         a directory needing also to be encoded. The failure would also delete the
         `src` which was not desirable behavior. Fixes deletion of src on encoding
         error. (https://github.com/ansible-collections/ibm_zos_core/pull/321).
+      - zos_copy - Fixes wrongful creation of destination backups when module option
+        `force` is true, creating emergency backups meant to restore the system to
+        its initial state in case of a module failure only when force is false. (https://github.com/ansible-collections/ibm_zos_core/pull/590)
+      - zos_copy - Fixes a bug where copying a member from a loadlib to another loadlib
+        fails. (https://github.com/ansible-collections/ibm_zos_core/pull/640)
+      - zos_copy - Fixes a bug where if a destination has accented characters in its
+        content, the module would fail when trying to determine if it is empty. (https://github.com/ansible-collections/ibm_zos_core/pull/634)
+      - zos_copy - Fixes a bug where the computed record length for a new destination
+        dataset would include newline characters. (https://github.com/ansible-collections/ibm_zos_core/pull/620)
       - zos_copy - module was updated to correct a bug in the case when the destination
         (dest) is a PDSE and the source (src) is a Unix Systems File (USS). The module
         would fail in determining if the PDSE actually existed and try to create it
@@ -395,24 +404,28 @@ releases:
         uncataloged data set. This is unexpected behavior and does not align to documentation;
         correct behavior is that when a volume is provided that is the first place
         the module should look for the data set, whether or not it is cataloged. (https://github.com/ansible-collections/ibm_zos_core/pull/325).
+      - zos_data_set - Fixes a bug where the default record format FB was actually
+        never enforced and when enforced it would cause VSAM creation to fail with
+        a Dynalloc failure. Also cleans up some of the options that are set by
+        default when they have no bearing for batch. (https://github.com/ansible-collections/ibm_zos_core/pull/647)
       - zos_fetch - Updates the modules behavior when fetching VSAM data sets such
         that the maximum record length is now determined when creating a temporary
         data set to copy the VSAM data into and a variable-length (VB) data set is
         used. (https://github.com/ansible-collections/ibm_zos_core/pull/350)
-      - zos_job_output - fixes a bug that returned all ddname's when a specific ddnamae
+      - zos_job_output - Fixes a bug that returned all ddname's when a specific ddnamae
         was provided. Now a specific ddname can be returned and all others ignored.
         (https://github.com/ansible-collections/ibm_zos_core/pull/334)
       - zos_job_query - was updated to correct a boolean condition that always evaluated
         to "CANCELLED". (https://github.com/ansible-collections/ibm_zos_core/pull/312).
-      - zos_mount - fixed option `tag_ccsid` to correctly allow for type int. (https://github.com/ansible-collections/ibm_zos_core/pull/511)
+      - zos_mount - Fixes option `tag_ccsid` to correctly allow for type int. (https://github.com/ansible-collections/ibm_zos_core/pull/511)
       - zos_mvs_raw - module was updated to correct a bug when no DD statements were
         provided. The module when no option was provided for `dds` would error, a
         default was provided to correct this behavior. (https://github.com/ansible-collections/ibm_zos_core/pull/336)
-      - zos_operator - fixed case sensitive error checks, invalid, error & unidentifiable
+      - zos_operator - Fixes case sensitive error checks, invalid, error & unidentifiable
         (https://github.com/ansible-collections/ibm_zos_core/issues/389).
-      - zos_operator - fixed such that specifying wait_time_s would throw an error
+      - zos_operator - Fixes such that specifying wait_time_s would throw an error
         (https://github.com/ansible-collections/ibm_zos_core/issues/389).
-      - zos_operator - fixed the wait_time_s to default to 1 second (https://github.com/ansible-collections/ibm_zos_core/issues/389).
+      - zos_operator - Fixes the wait_time_s to default to 1 second (https://github.com/ansible-collections/ibm_zos_core/issues/389).
       - zos_operator - was updated to correct missing verbosity content when the option
         verbose was set to True. zos_operator - was updated to correct the trailing
         lines that would appear in the result content. (https://github.com/ansible-collections/ibm_zos_core/pull/400).
@@ -565,6 +578,13 @@ releases:
     - 549-job-submit-remove-jcl-uss-patch.yml
     - 550-trivial-mvs_zos_raw.yml
     - 552-zos_job_submit-max-rc.yaml
+    - 588-zos_copy-emergenxy-backup.yml
+    - 599-copy-carriage-return.yml
+    - 600-zos_copy-special-characters.yml
+    - 601-copy-loadlib-member.yml
+    - 627-all-modules.yml
+    - 647-zos_data_set_record_format.yml
+    - 650-doc-meta-data-updates.yml
     - v1.5.0-beta.1_summary.yml
     modules:
     - description: Gather z/OS system facts.

changelogs/fragments/650-doc-meta-data-updates.yml

@@ -0,0 +1,11 @@
+trivial:
+  - Update meta/* files to reflect release content and version, issue 433.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/650)
+  - Update community docs with Ansible version support statement, issue 630.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/650)
+  - Update documentation to align to corporate wording, issue 649
+    (https://github.com/ansible-collections/ibm_zos_core/pull/650)
+  - zos_job_output - Update documentation to remove unicode text in doc, issue 651.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/650)
+  - zos_operator - update documentation and examples, issue 390.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/650)

docs/source/filters.rst

@@ -28,7 +28,7 @@ For more details on filters, review the filters and documentation under
 the `filter`_ directory included in the collection.
 
 .. _filter:
-   https://github.com/ansible-collections/ibm_zos_core/tree/master/plugins/filter/
+   https://github.com/ansible-collections/ibm_zos_core/tree/main/plugins/filter/
 
 
 

docs/source/index.rst

@@ -44,15 +44,15 @@ The IBM z/OS core collection includes `connection plugins`_,
 ansible-doc to automate tasks on z/OS.
 
 .. _connection plugins:
-   https://github.com/ansible-collections/ibm_zos_core/tree/master/plugins/connection/
+   https://github.com/ansible-collections/ibm_zos_core/tree/main/plugins/connection/
 .. _action plugins:
-   https://github.com/ansible-collections/ibm_zos_core/tree/master/plugins/action/
+   https://github.com/ansible-collections/ibm_zos_core/tree/main/plugins/action/
 .. _modules:
-    https://github.com/ansible-collections/ibm_zos_core/tree/master/plugins/modules/
+    https://github.com/ansible-collections/ibm_zos_core/tree/main/plugins/modules/
 .. _sample playbooks:
-    https://github.com/ansible-collections/ibm_zos_core/tree/master/playbooks/
+    https://github.com/ansible-collections/ibm_zos_core/tree/main/playbooks/
 .. _filters:
-   https://github.com/ansible-collections/ibm_zos_core/tree/master/plugins/filter/
+   https://github.com/ansible-collections/ibm_zos_core/tree/main/plugins/filter/
 
 
 .. toctree::