Release Requirements Checklist

This checklist is nearly a chronological ordering of the release tasks to complete for any given version of IBM Ansible z/OS core collection. This template is for both Automation Hub and Galaxy, you may not be releasing to Hub, for those you may skip the items. You should be checking off each task as it completes.

General workflow

This a subsequent release (not a patch) thus the Pull Request Tasks (below) will be merged into main then back into dev to allow for the meta data updates to propagate as well as the release tag.

Its best to use a staging branch, eg staging-v1.6.0-beta.1 with a pull request pointing at main. Thus it should look like:
staging-v1.6.0-beta.1 ---> main--> dev.

Pull Request Tasks for branch staging-v1.6.0-beta.1

• Update galaxy.yml
• Update meta/runtime.yml
• Update meta/ibm_zos_core_meta.yml
• Update README.md
• Review copyrights are updated as needed, e.g. current year if changes are made
• Generate module docs (restructured text - RST) and check it into the release branch
• Add a change log summary fragment for this version
• Generate CHANGELOG.rst
• Create release notes
• Review all module source imports; ensure sure no new imports are subject to license discrepancies

Technical Writer Tasks

• Ensure all technical writer Git issues are resolved for this release

Quality assurance

• Open a pull request for staging-v1.6.0-beta.1 against main
• Full pipeline regression at 100% success
  • Certify on IBM Enterprise Python versions 3.10 or 3.11 (with the latest ptf for env var PYTHONSTDINENCODING)
  • Certify on IBM Enterprise Python and new environment var
  • Certify on ZOAU 1.2.2
  • Certify on `ansible-core v2.14.x
  • Ensure RUN_ALL_TESTS is selected
• Run the galaxy importer (currently a manual step as its not part of the pipeline yet)
  • python -m galaxy_importer.main ibm-ibm_zos_core-1.5.0.tar.gz.
  • Check output log for any errors/issues. Look for the following:
  • Collection loading complete
  • Importer processing completed successfully

Certification Tasks

• Build the image from staging-v1.6.0-beta.1, upack it up, inspect the contents
• Test collection quality with an upload to the IBM HCF development Galaxy Server by uploading the build from branch staging-v1.6.0-beta.1.
• Complete the collection release task pull requests and merge the PR (staging-v1.6.0-beta.1)into the main branch
• Test collection quality again with a new build from main and now upload to the Ansible development Galaxy Server

Scans

• Run a Mend scan and check the results into the designated repository
• Run a Bandit scan and check the results into the designated repository

Release tasks (In this order)

• Upload to Galaxy
• Git tag: Merge to main and tag else if main and release have diverged, tag the release branch, see git workflow.
• Open a Git issue in z_ansible_collections_doc to have Red Hat® Ansible Certified Content for IBM Z docs generated

Log collection

• Copy any additional playbook or manual tests performed into the release folder
• Copy the pipeline log from Jenkins into the release folder
• Copy the Galaxy import log in the release folder
• Copy the Automation Hub import log into the release folder
• Copy the git log (git log --pretty=oneline) into the release folder