Merge pull request #123 from ansible-collections/andrewtwydell-105

1.0.5 release

.ansible-lint-ignore

@@ -0,0 +1,2 @@
+# This file contains ignores rule violations for ansible-lint
+changelogs/changelog.yaml yaml[indentation]

.travis.yml

@@ -9,6 +9,7 @@ env:
   - ANSIBLE_VERSION="stable-2.12"
   - ANSIBLE_VERSION="stable-2.13"
   - ANSIBLE_VERSION="stable-2.14"
+  - ANSIBLE_VERSION="stable-2.15"
   - ANSIBLE_VERSION="devel"
 matrix:
   exclude:
@@ -19,11 +20,15 @@ matrix:
       env: ANSIBLE_VERSION="stable-2.13"
     - python: "2.7"
       env: ANSIBLE_VERSION="stable-2.14"
+    - python: "2.7"
+      env: ANSIBLE_VERSION="stable-2.15"
     - python: "2.7"
       env: ANSIBLE_VERSION="devel"
       # Python 3.8 max ansible version is 2.13
     - python: "3.8"
       env: ANSIBLE_VERSION="stable-2.14"
+    - python: "3.8"
+      env: ANSIBLE_VERSION="stable-2.15"
     - python: "3.8"
       env: ANSIBLE_VERSION="devel"
       # Ansible 2.11 max python version support is 3.9

.travis/build_and_test.sh

@@ -6,8 +6,8 @@ git config --global --add safe.directory /root/ansible_collections/ibm/ibm_zos_c
 
 pip install -r /root/ansible_collections/ibm/ibm_zos_cics/dev-requirements.txt
 
-# ansible-lint requires python >= 3.8
-if [ "$TRAVIS_PYTHON_VERSION" != "2.7" ]; then
+# ansible-lint requires python >= 3.9
+if [ "$TRAVIS_PYTHON_VERSION" != "2.7" ] && [ "$TRAVIS_PYTHON_VERSION" != "3.8" ]; then
     echo ""
     echo "##########################################################"
     echo "###################### Ansible-lint ######################"

CHANGELOG.rst

@@ -0,0 +1,83 @@
+==============================
+ibm.ibm_zos_cics Release Notes
+==============================
+
+.. contents:: Topics
+
+
+v1.0.5
+======
+
+Release Summary
+---------------
+
+This release contains one bug fix.
+
+Bugfixes
+--------
+
+- Missing requirements.txt - requirements.txt was not included in the built collection. Fix removes this from the build_ignore section of the galaxy.yml.
+
+v1.0.4
+======
+
+Release Summary
+---------------
+
+This release contains a number of new features and bug fixes.
+
+Minor Changes
+-------------
+
+- Provide variables for all modules in one go using Ansible's `group module defaults <https://docs.ansible.com/ansible/2.8/user_guide/playbooks_module_defaults.html#module-defaults-groups>`_ support. The group name for the CMCI modules is ``cmci_group``.
+
+Bugfixes
+--------
+
+- cmci_get - prevent ``cmci_get`` from failing if no records are found via the ``fail_on_nodata`` option. The default value is ``true`` if not specified.
+
+v1.0.3
+======
+
+Release Summary
+---------------
+
+This release contains a number of new features and bug fixes.
+
+Minor Changes
+-------------
+
+- Added support for CMCI feedback on failed CMCI requests.
+- Updated timeout support on requests to be configurable via the timeout option. The default value is 30 seconds if not specified.
+
+Bugfixes
+--------
+
+- Improve sanitisation and validation of parameters.
+
+v1.0.1
+======
+
+Release Summary
+---------------
+
+Fix some documentation issues on Hub, and include some missing documentation about requirements.
+
+v1.0.0
+======
+
+Release Summary
+---------------
+
+Initial release of the IBM® z/OS® CICS® collection, also referred to as ibm_zos_cics, which is part of the broader offering Red Hat® Ansible® Certified Content for IBM Z®.
+
+This collection can manage CICS and CICSPlex® SM resources and definitions by calling the CMCI REST API, which can be configured in a CICSplex or in a stand-alone region.
+
+New Modules
+-----------
+
+- ibm.ibm_zos_cics.cmci_action - Perform actions on CICS and CICSPlex SM resources
+- ibm.ibm_zos_cics.cmci_create - Create CICS and CICSPlex SM definitions
+- ibm.ibm_zos_cics.cmci_delete - Delete CICS and CICSPlex SM resources
+- ibm.ibm_zos_cics.cmci_get - Query CICS and CICSPlex SM resources and definitions
+- ibm.ibm_zos_cics.cmci_update - Update CICS and CICSPlex resources and definitions

README.md

@@ -1,6 +1,4 @@
-# (c) Copyright IBM Corp. 2020,2021
-IBM z/OS CICS collection
-========================
+# IBM z/OS CICS collection
 
 The **IBM® z/OS® CICS® collection**, also represented as **ibm\_zos\_cics**
 in this document, is part of the broader initiative to bring Ansible Automation to IBM Z® through the offering
@@ -12,8 +10,7 @@ such as the [IBM z/OS core collection](https://github.com/ansible-collections/ib
 It is also possible to use it independently to perform automation tasks solely in CICS.
 
 
-Red Hat Ansible Certified Content for IBM Z
-===========================================
+## Red Hat Ansible Certified Content for IBM Z
 
 **Red Hat® Ansible Certified Content for IBM Z** provides the ability to
 connect IBM Z® to clients' wider enterprise automation strategy through the
@@ -36,20 +33,22 @@ as **certified** and **IBM supported** for
 
 For guides and reference, please review the [documentation](https://ibm.github.io/z_ansible_collections_doc/index.html).
 
-Features
-========
+## Features
 
 The IBM CICS collection includes
 [modules](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/modules.html),
 [sample playbooks](https://github.com/IBM/z_ansible_collections_samples),
 and ansible-doc to automate tasks in CICS.
 
+## Contributing
 
-Copyright
-=========
-© Copyright IBM Corporation 2021.
+We welcome contributions! Find out how in our [contribution guide](CONTRIBUTING.md).
 
-License
-=======
-This collection is licensed under [Apache License,
+## Copyright 
+
+© Copyright IBM Corporation 2021, 2023.
+
+## License
+
+This collection is licensed under the [Apache License,
 Version 2.0](https://opensource.org/licenses/Apache-2.0).

changelogs/.plugin-cache.yaml

@@ -0,0 +1,41 @@
+objects: {}
+plugins:
+  become: {}
+  cache: {}
+  callback: {}
+  cliconf: {}
+  connection: {}
+  httpapi: {}
+  inventory: {}
+  lookup: {}
+  module:
+    cmci_action:
+      description: Perform actions on CICS and CICSPlex SM resources
+      name: cmci_action
+      namespace: ''
+      version_added: 1.0.0
+    cmci_create:
+      description: Create CICS and CICSPlex SM definitions
+      name: cmci_create
+      namespace: ''
+      version_added: 1.0.0
+    cmci_delete:
+      description: Delete CICS and CICSPlex SM resources
+      name: cmci_delete
+      namespace: ''
+      version_added: 1.0.0
+    cmci_get:
+      description: Query CICS and CICSPlex SM resources and definitions
+      name: cmci_get
+      namespace: ''
+      version_added: 1.0.0
+    cmci_update:
+      description: Update CICS and CICSPlex resources and definitions
+      name: cmci_update
+      namespace: ''
+      version_added: 1.0.0
+  netconf: {}
+  shell: {}
+  strategy: {}
+  vars: {}
+version: 1.0.5

changelogs/changelog.yaml

@@ -0,0 +1,70 @@
+ancestor: null
+releases:
+  1.0.0:
+    changes:
+      release_summary: "Initial release of the IBM\xAE z/OS\xAE CICS\xAE collection,
+        also referred to as ibm_zos_cics, which is part of the broader offering Red
+        Hat\xAE Ansible\xAE Certified Content for IBM Z\xAE.\n\nThis collection can
+        manage CICS and CICSPlex\xAE SM resources and definitions by calling the CMCI
+        REST API, which can be configured in a CICSplex or in a stand-alone region."
+    fragments:
+    - 100-retrospective.yml
+    modules:
+    - description: Perform actions on CICS and CICSPlex SM resources
+      name: cmci_action
+      namespace: ''
+    - description: Create CICS and CICSPlex SM definitions
+      name: cmci_create
+      namespace: ''
+    - description: Delete CICS and CICSPlex SM resources
+      name: cmci_delete
+      namespace: ''
+    - description: Query CICS and CICSPlex SM resources and definitions
+      name: cmci_get
+      namespace: ''
+    - description: Update CICS and CICSPlex resources and definitions
+      name: cmci_update
+      namespace: ''
+    release_date: '2021-02-17'
+  1.0.1:
+    changes:
+      release_summary: Fix some documentation issues on Hub, and include some missing
+        documentation about requirements.
+    fragments:
+    - 101-retrospective.yml
+    release_date: '2021-03-02'
+  1.0.3:
+    changes:
+      bugfixes:
+      - Improve sanitisation and validation of parameters.
+      minor_changes:
+      - Added support for CMCI feedback on failed CMCI requests.
+      - Updated timeout support on requests to be configurable via the timeout option.
+        The default value is 30 seconds if not specified.
+      release_summary: This release contains a number of new features and bug fixes.
+    fragments:
+    - 103-retrospective.yml
+    release_date: '2021-07-15'
+  1.0.4:
+    changes:
+      bugfixes:
+      - cmci_get - prevent ``cmci_get`` from failing if no records are found via the
+        ``fail_on_nodata`` option. The default value is ``true`` if not specified.
+      minor_changes:
+      - Provide variables for all modules in one go using Ansible's `group module
+        defaults <https://docs.ansible.com/ansible/2.8/user_guide/playbooks_module_defaults.html#module-defaults-groups>`_
+        support. The group name for the CMCI modules is ``cmci_group``.
+      release_summary: This release contains a number of new features and bug fixes.
+    fragments:
+    - 104-retrospective.yml
+    release_date: '2023-04-21'
+  1.0.5:
+    changes:
+      bugfixes:
+      - Missing requirements.txt - requirements.txt was not included in the built
+        collection. Fix removes this from the build_ignore section of the galaxy.yml.
+      release_summary: This release contains one bug fix
+    fragments:
+    - include-requirements-txt.yaml
+    - release_summary.yaml
+    release_date: '2023-05-16'

changelogs/config.yaml

@@ -0,0 +1,32 @@
+changelog_filename_template: ../CHANGELOG.rst
+changelog_filename_version_depth: 0
+changes_file: changelog.yaml
+changes_format: combined
+ignore_other_fragment_extensions: true
+keep_fragments: false
+mention_ancestor: true
+new_plugins_after_name: removed_features
+notesdir: fragments
+prelude_section_name: release_summary
+prelude_section_title: Release Summary
+sanitize_changelog: true
+sections:
+  - - major_changes
+    - Major Changes
+  - - minor_changes
+    - Minor Changes
+  - - breaking_changes
+    - Breaking Changes / Porting Guide
+  - - deprecated_features
+    - Deprecated Features
+  - - removed_features
+    - Removed Features (previously deprecated)
+  - - security_fixes
+    - Security Fixes
+  - - bugfixes
+    - Bugfixes
+  - - known_issues
+    - Known Issues
+title: ibm.ibm_zos_cics
+trivial_section_name: trivial
+use_fqcn: true

docs/source/community_guides.rst

@@ -20,7 +20,7 @@ For a developer guide on how to develop and run test cases for IBM® z/OS® CICS
 .. _git issues:
    https://github.com/ansible-collections/ibm_zos_cics/issues
 .. _Developer guide:
-   https://github.com/ansible-collections/ibm_zos_cics/blob/main/devguide.md
+   https://github.com/ansible-collections/ibm_zos_cics/blob/main/CONTRIBUTING.md
 
 
 

docs/source/release_notes.rst

@@ -7,6 +7,13 @@
 Releases
 ========
 
+Version 1.0.5
+=============
+What's New
+-------------------
+* Bug fix that includes the ``requirements.txt`` file in the built collection.
+
+
 Version 1.0.4
 =============
 What's New

galaxy.yml

@@ -8,7 +8,7 @@ namespace: ibm
 name: ibm_zos_cics
 
 # The collection version
-version: 1.0.4
+version: 1.0.5
 
 # Collection README file
 readme: README.md
@@ -53,15 +53,19 @@ build_ignore:
   - .idea
   - .gitignore
   - .ansible-test
-  - tests
+  - tests/integration
+  - tests/unit
+  - tests/output
+  - tests/__init__.py
   - docs
   - CONTRIBUTING.md
   - build.sh
-  - requirements.txt
   - dev-requirements.txt
   - doc-requirements.txt
-  - devguide.md
   - .travis
   - .github
   - .ansible-lint
   - .travis.yml
+  - .whitesource
+  - ibm-ibm_zos_cics-*.tar.gz
+  - changelogs

meta/ibm_zos_cics_meta.yml

@@ -1,6 +1,6 @@
 ---
 name: ibm_zos_cics
-version: 1.0.4
+version: 1.0.5
 managed_requirements:
   - name: Python
     version: ">=2.7"

plugins/modules/cmci_action.py

@@ -19,6 +19,7 @@
     L(CMCI REST API,https://www.ibm.com/docs/en/cics-ts/latest?topic=programming-cmci-rest-api-reference).
     For information about how to compose PUT requests, see
     L(CMCI PUT requests,https://www.ibm.com/docs/en/cics-ts/latest?topic=requests-cmci-put).
+version_added: 1.0.0
 author:
   - Stewart Francis (@stewartfrancis)
   - Tom Latham (@Tom-Latham)

plugins/modules/cmci_create.py

@@ -19,6 +19,7 @@
     L(CMCI REST API,https://www.ibm.com/docs/en/cics-ts/latest?topic=programming-cmci-rest-api-reference).
     For information about how to compose POST requests, see
     L(CMCI POST requests,https://www.ibm.com/docs/en/cics-ts/latest?topic=requests-cmci-post).
+version_added: 1.0.0
 author:
   - Stewart Francis (@stewartfrancis)
   - Tom Latham (@Tom-Latham)