Jump to: navigation, search

Difference between revisions of "QA/releases"

< QA
(Hacking)
(Tempest)
(17 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 +
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 =
 
= Project Releases =
  
== tempest ==
+
== 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 [https://releases.openstack.org/victoria/schedule.html Victoria Release Schedule]
 +
* Devstack: Week R-3 (Hard StringFreeze) of cycle release schedule.
 +
* Grenade: Week R-3 (Hard StringFreeze) of cycle release schedule.
 +
* Patrole: Week R-3 (Hard StringFreeze) of cycle release schedule.
 +
 
 +
 
 +
== 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/703646/
 +
 
 +
=== 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:
  
With the start of branchless tempest there are no long any tempest releases, but instead incremental tags for each OpenStack release milestones. The tag should be incremented to coincide with either a new OpenStack release, or the EOL of a supported stable branch. For example, the tempest-2 tag was added at the Juno release and was used to mark adding support for the Kilo release. The next tag tempest-3 will be used to either signify the start of L development or the EOL of icehouse, whichever occurs first.
+
== Project with release mode: independent ==
  
The procedure for pushing a new tempest tag is:
+
Below projects are with independent release and not associated with OpenStack cycle release.
  
* Identify the commit you would like to tag as the next tag and write down the sha1. This can just be the current HEAD commit but make sure you use use the sha1 for the commit from the log and not some other shorthand as that will likely change
+
* hacking
* Push the version bump in setup.cfg. For example, see: http://git.openstack.org/cgit/openstack/tempest/commit/?id=66d8831d173cd4713bff8875bd516ad132db9070 '''this step must occur before you push the tag''' or you risk breaking pbr's semver check
+
** Example: https://review.opendev.org/#/c/715578/
* Once the version bump is in master you can tag the release and push it to gerrit with:
+
* 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
  
        git tag -s 3  $(sha1_to_tag) && git push gerrit 3
+
== Project with no release==
  
this will add the signed tag to the git repo and generate a tarball and store it here: http://tarballs.openstack.org/tempest/
+
Below projects are with no release and maintained as master version only.
  
== tempest-lib ==
+
* coverage2sql
 +
* devstack-plugin-ceph
 +
* 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
  
The mechanics for pushing a new tempest-lib release are basically the same (pushing a tag to gerrit) however the operations that get performed during this process are different. Also tempest-lib conforms to more traditional semver scheme and adheres to the mantra "release early, release often"
 
  
== Devstack ==
+
= Projects with only Branches =
Release Branch Procedure:
 
  
== grenade ==
+
For the most part, Devstack and Grenade only have branches, which need to be cut when other projects get '''stable/*''' branches during a
Just like devstack grenade doesn't have publish releases or tags, but at each OpenStack release a stable branch needs to be created. Unlike grenade however there are also some updates that need to be made in repo to handle the new branch names for upgrading.
+
release.
  
# The new devstack stable branch needs to be created. Without a stable devstack branch grenade won't have anything new to update from for master.
+
* Devstack
# The grenade stable branch needs to be created just like devstack
+
** Step1: Wait for stable/* branch to exist on the projects in Devstack repo
# The defaults in the new stable branch need to be updated for example see: https://review.openstack.org/129645
+
** Step2: Propose to openstack/releases to create a stable/foo branch for Devstack
# Update the grenade master branch to upgrade from the newly created release to master and update the name of the working dev release. For example see: https://review.openstack.org/#/c/128959/
+
*** Example: https://review.opendev.org/#/c/685400/
# At this point devstack-gate needs to be updated so that the branches being update from and to are correct for all the gating jobs. For example see: https://review.openstack.org/#/c/128974/
+
** Step3: Update .gitreview for stable/foo – patch from OpenStack Release Bot
 +
*** Example: https://review.openstack.org/#/c/647855/
 +
** 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/  
  
== Hacking ==
+
* Grenade
 +
** Step1: Wait for stable/branch 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/x – from OpenStack Release Bot
 +
*** Example: https://review.opendev.org/#/c/686991/
 +
** Step5: Update devstack-gate logic to use the new branches
 +
*** Example: new- https://review.openstack.org/#/c/591594/
  
Versioning: http://docs.openstack.org/developer/hacking/readme.html#versioning
+
* devstack-plugin-container: hanled by devstack-plugin-container team.
  
Hacking has a branch for every major.minor release. For example: 0.9.x and 0.8.x. The process for cutting a new major or minor release involves creating a new branch and pushing a tag (major.minor.0). At that point patches that fit the versioning requirements can be backported to the stable branch for maintenance releases.
+
Once all done then you deserve to go for beer \o/

Revision as of 10:52, 18 September 2020

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
  • Devstack: Week R-3 (Hard StringFreeze) of cycle release schedule.
  • Grenade: Week R-3 (Hard StringFreeze) of cycle release schedule.
  • Patrole: Week R-3 (Hard StringFreeze) of cycle release schedule.


Project with release mode: cycle-with-intermediary

Tempest

Patrole

Project with release mode: independent

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

Project with no release

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

  • coverage2sql
  • devstack-plugin-ceph
  • 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-plugin-container: hanled by devstack-plugin-container team.

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