Files
releases/doc/source/reference/deliverable_types.rst
Hervé Beraud b872f50b96 Clarifying how to deal with tempest-plugin during series
Previously the tempest plugins were driven by the legacy
`cycle-automatic` model. However this model have been abandoned.

The cycle-automatic release model is now better described by the
`cycle-with-intermediary` model combined with `stable-branch-type: none`

The `cycle-automatic` model was used by specific technical deliverables
that needed to be automatically released once at the end of a cycle.

the tempest-plugin are branchless and `cycle-with-intermediary`
however our process doesn't handle them at the end of the cycle
like did the `cycle-automatic`.

These changes clarifying that point.

Change-Id: I6b3619a44d0aea1fa4852e650cbafcb08c853353
2021-03-30 18:11:36 +02:00

2.9 KiB

Deliverable Types

The type of a deliverable affects in which section it is listed on the releases.openstack.org website, as well as which deadline applies to it within a development cycle.

service

This deliverable type indicates that a project provides a user-facing long-running service with a REST API. The deadline for producing such a deliverable in a development cycle is the 'Final RCs and intermediary releases' week, usually located at R-1.

library

This deliverable type indicates that a project is a library, middleware, or other piece of software that is used to build another project and does not, by itself, provide a long-running service or stand-alone tool. The deadline for producing such a deliverable in a development cycle is the 'Final release for non-client libraries' week, usually located at R-6.

  • The repository contains software used as a library for the loose and commonly-understood definition of "library".

client-library

This deliverable type indicates that a project is a library containing a client for an OpenStack service that is intended to be consumed by other OpenStack services (so not a general-purpose user client such as shade). The deadline for producing such a deliverable in a development cycle is the 'Final release for client libraries' week, usually located at R-5.

horizon-plugin

This deliverable type indicates that a deliverable is meant to be consumed by Horizon as a plug-in, to provide an integrated web UI for a given project. The deadline for producing such a deliverable in a development cycle is the 'Final RCs and intermediary releases' week, usually located at R-1.

  • The repository contains code meant to be dynamically loaded by OpenStack Horizon to provide UI to specific projects.

trailing

This deliverable type indicates that a deliverable is a deployment tool or some other tool that builds on top of an existing release. The deadline for producing such a deliverable in a development cycle is the 'cycle-trailing Release Deadline', usually located 3 months after the coordinated release.

tempest-plugin

This deliverable type indicates that a deliverable is a tempest plugin. those need to be automatically released once at the end of a cycle. Those may, optionally, also be released in the middle of the cycle. Those do not need a stable branch created. Those deliverables were previously managed by the legacy cycle-automatic model.

other

Deliverables without a more specific categorization are listed as other. The deadline for producing such a deliverable in a development cycle is the 'Final RCs and intermediary releases' week, usually located at R-1.