Revision as of 20:07, 24 September 2021

OpenStack QA releases its tooling as per each tool release model and also needs to take care of the new branch set on devstack and grenade. This page explain the process and tasks QA team needs to do on every OpenStack release.

Project Releases

Feature Freeze

QA projects follow different release models (explained in the next section) so feature freeze is not applicable to all of them. We do feature freeze for below projects only:

• Tempest: Week R-3 (Hard StringFreeze) of cycle release schedule. Example Victoria Release Schedule
  • The following is the subject of Feature Freeze:
    • New tests
      • New API tests are OK to merge after seeing a green gate
      • Scenario tests need to be discussed during QA office hour and will be decided based on their complexity
    • New dependencies/dependency bumps
      • Not to be merged unless necessary for the release.
    • Non-stable/stable interface
      • Any removal of deprecated interfaces or variable or any change which has possibility of breaking the plugins users.
      • If non-deprecated interface then we need to postpone to the next cycle.
    • Any framework change will be checked dynamically and decided whether to postpone to the next release or not.

• Devstack: Week R-3 (Hard StringFreeze) of cycle release schedule.
  • The following is the subject of Feature Freeze:
    • Changing the default behavior/configuration.
    • New backup/driver support if it's not isolated.

• Grenade: Week R-3 (Hard StringFreeze) of cycle release schedule.
  • The following is the subject of Feature Freeze:
    • Changing the default behavior/configuration.

• Patrole: Week R-3 (Hard StringFreeze) of cycle release schedule.
  • The following is the subject of Feature Freeze:
    • Same as for Tempest.

Project with release mode: cycle-with-intermediary

Tempest

• Step0: Read and follow the "How to pin upper-constraints in tox.ini" steps.
  • https://docs.openstack.org/tempest/latest/requirement_upper_constraint_for_tempest.html
• Step1: Add Release note to mark the release
  • Example:
    • Intermediate release https://review.openstack.org/#/c/514873/2
    • Cycle release –https://review.opendev.org/#/c/685401/
    • EOL stable release – https://review.opendev.org/#/c/703255/
• Step2: Push release tag to openstack/release repo
  • Example:
    • Intermediate - https://review.opendev.org/#/c/688613/
    • Cycle release- https://review.opendev.org/#/c/685406/
• Step3: Add release notes page after release patch is merged
  • Example:
    • Cycle Release- https://review.opendev.org/#/c/687123/
• Step4: Add releasenotes page link in openstck/release
  • Example: https://review.opendev.org/#/c/687619/
• Step5: Remove the End of Support branch job from tempest gate if release is for end of support for any stable branch
  • Example: https://review.opendev.org/#/c/766770/

Patrole

• Step1: Add Release note to mark the release
  • Example: https://review.opendev.org/#/c/685429/
• Step2: Push release tag to openstack/release repo
  • Example: https://review.opendev.org/#/c/685430/
• Step3: Add release notes page after release patch is merged
  • Example: https://review.opendev.org/#/c/687124/
• Step4: Add releasenotes page link in openstck/release
  • Example: https://review.opendev.org/#/c/687582/
• Step5: Remove the End of Support branch job from tempest gate if release is for end of support for any stable branch:

Project with release mode: independent

Below projects are with independent release and not associated with OpenStack cycle release.

• hacking
  • Example: https://review.opendev.org/#/c/715578/
• os-testr
  • Example: https://review.opendev.org/#/c/713142/
• bashate
  • Example: https://review.opendev.org/#/c/710560/
• devstack-tools
  • Example: https://review.opendev.org/#/c/710561/
• eslint-config-openstack
  • Example: https://review.opendev.org/#/c/785024/

Project with no release

Below projects are with no release and maintained as master version only.

• coverage2sql
• devstack-plugin-cookiecutter
• devstack-plugin-open-cas
• devstack-plugin-nfs
• devstack-vagrant
• karma-subunit-reporter
• openstack-health
• os-performance-tools
• stackviz
• tempest-stress
• tempest-plugin-cookiecutter

Projects with only Branches

For the most part, Devstack and Grenade only have branches, which need to be cut when other projects get stable/* branches during a release.

• Devstack
  • Step1: Wait for stable/* branch to exist on the projects in Devstack repo
  • Step2: Propose to openstack/releases to create a stable/foo branch for Devstack
    • Example: https://review.opendev.org/#/c/685400/
  • Step3: Update .gitreview for stable/foo – patch from OpenStack Release Bot
    • Example: https://review.openstack.org/#/c/647855/
    • In the same patch, if exist then remove the zuul pragma to match master and feature/r1
      • https://review.opendev.org/c/openstack/devstack/+/810947
  • Step4: Update branches for stable/foo
    • Example: https://review.openstack.org/#/c/647867/
  • Step5: Update DEVSTACK_SERIES on master Devstack
    • Example: https://review.opendev.org/#/c/687112/
  • Step6: Update lib/tempest to hardcode max microversions and extensions on stable/foo
    • Example:
      • https://review.opendev.org/#/c/687115/
      • https://review.opendev.org/#/c/687176/
  • Step7: After Devstack has been branched. Add a new stable branch job in the Tempest pipeline.
    • Example: https://review.opendev.org/#/c/686781
  • Step8: After Devstack has been branched. Configure devstack-gate to run the new stable branch jobs.
    • Example: https://review.opendev.org/#/c/686776/
  • Step9: After Devstack has been branched. Add the new stable branch to the list of branches in the periodic-stable job templates in openstack-zuul-jobs.
    • Example: https://review.opendev.org/#/c/687122/

• Grenade
  • Step1: Wait for stable/foo to exist on Devstack
  • Step2: Propose to openstack/releases to create a stable/foo branch
    • Example: https://review.opendev.org/#/c/686771/
  • Step3: Update .gitreview for stable/foo – from OpenStack Release Bot
    • Example: https://review.opendev.org/#/c/686991/
  • Step4: Update the master grenade setting for stable/foo to master upgrade
    • Example: https://review.opendev.org/c/openstack/grenade/+/785006
  • Step5: Update grenade setting in stable/foo
    • https://review.opendev.org/c/openstack/grenade/+/785007

• devstack-plugin-container:
  • Once devstack is branched, push the final release with the current hash to cut the branch, similar to devstack.
    • Example: https://review.opendev.org/c/openstack/releases/+/785180

• devstack-plugin-ceph
  • Once devstack is branched, push the final release with the current hash to cut the branch, similar to devstack.
    • Example: https://review.opendev.org/c/openstack/releases/+/786069

Once all is done then you deserve to go for beer \o/