Chronological Release Liaison Guide¶
This is a reference guide that a release liaison may use as an aid, if they choose.
Cyborg uses the standard Project Team Lead (PTL) governance model. The release liaison is appointed by the PTL and is responsible for requesting releases, reviewing Feature Freeze Exception (FFE) requests, and coordinating release-related activities with the team.
How to Use This Guide¶
This guide is organized chronologically to follow the OpenStack release cycle from PTG planning through post-release activities. You can use it in two ways:
- For New Release Liaisons
Read through the entire guide to understand the full release cycle, then bookmark it for reference during your term.
- For Experienced Release Liaisons
Jump directly to the relevant section for your current phase in the release cycle. Each major section corresponds to a specific time period.
- Key Navigation Tips
The Glossary defines all acronyms and terminology used
Time-sensitive activities are clearly marked by milestone phases
PTL coordination notes indicate when team collaboration is required
- Placeholder Convention
Terms shown in
<angle-brackets>(e.g.,<release>,<stable branch>) are placeholders that must be replaced with the actual values for your cycle.
PTL Coordination¶
Under the PTL model, the release liaison manages release activities through authority delegated by the PTL. The PTL retains final responsibility for Feature Freeze Exception (FFE) decisions and release timing. Under the distributed leadership model, where there is no PTL, the release liaison has final authority for those release-specific decisions. Major process changes and strategic decisions are made with team input.
This coordination approach ensures that:
Release activities are properly managed by a dedicated liaison
The PTL is kept informed of release progress and issues
Team input is gathered for significant decisions
Release processes remain responsive while maintaining team alignment
Project Context¶
Coordinate with the cyborg meeting (chair rotates each meeting, with volunteers requested at the end of each meeting)
Meeting etherpad: https://etherpad.opendev.org/p/openstack-cyborg-irc-meeting
IRC channel: #openstack-cyborg
Get acquainted with the release schedule
Example: https://releases.openstack.org/<current-release>/schedule.html
Familiarize yourself with Cyborg project repositories and tracking:
- Cyborg Main Repository
- Cyborg Specifications
Design specifications (not released)
- Python Cyborg Client
- Cyborg Tempest Plugin
Integration tests (follows tempest cycle)
- Cyborg Launchpad (Main)
- Python Cyborg Client Launchpad
- Cyborg Tempest Plugin Launchpad
Project Team Gathering¶
Event Liaison Coordination¶
Work with the project team to select an event liaison for PTG coordination. The event liaison is responsible for:
Reserving sufficient space at PTG for the project team’s meetings
Putting out an agenda for team meetings
Ensuring meetings are organized and facilitated
Documenting meeting results
If no event liaison is selected, these duties revert to the release liaison.
Monitor for OpenStack Events team queries on the mailing list requesting event liaison volunteers - teams not responding may lose event representation.
PTG Planning and Execution¶
Create PTG planning etherpad, retrospective etherpad and alert about it in cyborg meeting and dev mailing list
Run sessions at the PTG (if no event liaison is selected)
Do a retro of the previous cycle
Coordinate with team to establish agreement on the agenda for this release:
Review Days Planning: determine number of review days allocated for specs and implementation work
Freeze Dates Coordination: define Spec approval and Feature freeze dates through team collaboration
Release Schedule Modifications: modify the OpenStack release schedule if needed by proposing new dates (Example: https://review.opendev.org/c/openstack/releases/+/877094)
Discuss the implications of the SLURP or non-SLURP current release
Sign up for group photo at the PTG (if applicable)
After PTG¶
Send PTG session summaries to the dev mailing list
Add RFE bugs if you have action items that are simple to do but without an owner yet.
Update IRC #openstack-cyborg channel topic to point to new development-planning etherpad.
A few weeks before milestone 1¶
Remind contributors that specifications should ideally be proposed before milestone 1 so there is sufficient time for review before spec freeze
Plan a spec review day
Periodically check the series goals others have proposed in the “Set series goals” link:
Example: https://blueprints.launchpad.net/openstack-cyborg/<current-release>/+setgoals
Milestone 1¶
Propose development releases through the
openstack/releasesrepository:The Cyborg service follows the cycle-with-rc model. Development milestone releases are optional, but the service must publish at least one release candidate near the end of the cycle.
python-cyborgclientfollows the cycle-with-intermediary model. Create actual releases, rather than Launchpad bookkeeping, at appropriate milestone points.When releasing the first version of the client library for the cycle, bump the minor version to leave room for future stable branch releases.
Release stable branches of cyborg
Stable Branch Release Process¶
Prepare the stable branch for evaluation:
git checkout <stable branch>
git log --no-merges <last tag>..
Analyze commits to determine version bump according to semantic versioning.
Semantic Versioning Guidelines¶
Choose version bump based on changes since last release:
- Major Version (X)
Backward-incompatible changes that break existing APIs
- Minor Version (Y)
New features that maintain backward compatibility
- Patch Version (Z)
Bug fixes that maintain backward compatibility
Release Command Usage¶
Generate the release using OpenStack tooling:
Use the new-release command
Propose the release with version according to chosen semver format (x.y.z)
Summit¶
Responsibility Precedence for Summit Activities:
Project Update/Onboarding Liaisons (if appointed):
Project Update Liaison: responsible for giving the project update showcasing team’s achievements for the cycle to the community
Project Onboarding Liaison: responsible for giving/facilitating onboarding sessions during events for the project’s community
Event Liaison (if no Project Update/Onboarding liaisons exist):
Coordinates all Summit activities including project updates and onboarding
Release Liaison (if no Event Liaison is appointed):
Work with the team to ensure Summit activities are properly handled:
Prepare the project update presentation
Prepare the on-boarding session materials
Prepare the operator meet-and-greet session
Note
The team can choose to not have a Summit presence if desired.
A few weeks before milestone 2¶
Plan a spec review day (optional)
Milestone 2¶
Spec freeze (unless changed by team agreement at PTG)
Publish another Cyborg development milestone or
python-cyborgclientrelease if neededStable branch releases of cyborg
Shortly after spec freeze¶
Create a blueprint status etherpad to help track, especially non-priority blueprint work, to help things get done by Feature Freeze (FF). Example:
https://etherpad.opendev.org/p/cyborg-<release>-blueprint-status
Create or review a patch to add the next release’s specs directory so people can propose specs for next release after spec freeze for current release
Milestone 3¶
Feature freeze day
Client library freeze, release python-cyborgclient
Close out all blueprints, including “catch all” blueprints like mox, versioned notifications
Stable branch releases of cyborg
Start writing the cycle highlights
Week following milestone 3¶
Prefer to grant no Feature Freeze Exceptions (FFEs). Features should normally be complete by milestone 3 and incomplete work should be deferred to the next cycle.
If an FFE may be warranted, discuss it at the first IRC meeting after feature freeze with the requester present. The exception extends only until the next IRC meeting, normally one week later, and never beyond RC1.
Under the PTL model, the PTL makes the final decision and may delegate that decision to the release liaison. Under distributed leadership, the release liaison makes the final decision.
The code freeze between feature freeze and RC1 is normally about two weeks, so only low-risk work that is almost complete is likely to qualify.
Mark the max microversion for the release in the REST API Version History
A few weeks before RC¶
Update the release status etherpad with RC1 todos and keep track of them in meetings
Go through the bug list and identify any rc-potential bugs and tag them
RC¶
Follow the standard OpenStack release checklist process
If we want to drop backward-compat RPC code, we have to do a major RPC version bump and coordinate it just before the major release:
“Merge latest translations” means translation patches
Check for translations with:
Plan to produce only one release candidate. After RC1, only regressions introduced during the current development cycle are eligible for another release candidate. Anyone may nominate a current-cycle regression as an RC2 candidate, regardless of how it was discovered, but eligibility does not guarantee another release candidate.
RC1 creates the stable branch and
masterreopens for the next cycle. Longer-standing bugs can be fixed onmasterand backported after the coordinated release; they are not RC2 candidates. Distributions and packagers may already be validating RC1, so avoid additional candidates unless fixing an eligible regression justifies disrupting and restarting that work.Write the reno prelude for the release GA
Example: https://review.opendev.org/644412
Push the cycle-highlights in marketing-friendly sentences and propose to the openstack/releases repo. Usually based on reno prelude but made more readable and friendly
Example: https://review.opendev.org/644697
Immediately after RC¶
Look for bot proposed changes to reno and stable/<cycle>
Create the launchpad series for the next cycle
Set the development focus of the project to the new cycle series
Set the status of the new series to “active development”
Set the last series status to “current stable branch release”
Set the previous to last series status to “supported”
Repeat launchpad steps ^ for all cyborg deliverables.
Make sure the specs directory for the next cycle gets created so people can start proposing new specs
Make sure to move implemented specs from the previous release
Move implemented specs manually (TODO: add tox command in future)
Remove template files:
Note
The specs directory lives in the cyborg-specs repository. Run these commands there, not in the main cyborg repo.
rm doc/source/specs/<release>/index.rst rm doc/source/specs/<release>/template.rst
Ensure liaison handoff: either transition to new release liaison or confirm reappointment for next cycle
Glossary¶
- PTL
Project Team Lead - The elected leader of an OpenStack project team, responsible for overall project governance and coordination.
- FFE
Feature Freeze Exception - A request to add a feature after the feature freeze deadline. Should be used sparingly for low-risk, nearly complete features.
- GA
General Availability - The final release of a software version for production use.
- PTG
Project Team Gathering - A collaborative event where OpenStack project teams meet to plan and coordinate development activities.
- RC
Release Candidate - A pre-release version that is potentially the final version, pending testing and bug fixes.
- RFE
Request for Enhancement - A type of bug report requesting a new feature or enhancement to existing functionality.
- SLURP
Skip Level Upgrade Release Process - An extended maintenance release that allows skipping intermediate versions during upgrades.
- Summit
OpenStack Summit - A conference where the OpenStack community gathers for presentations, discussions, and project updates.
Miscellaneous Notes¶
How to track launchpad blueprint approvals¶
Maintainers with approval rights for cyborg-specs approve blueprints after
consulting the team. The release liaison updates the Launchpad status after
approval:
Set the approver to the maintainer who approved the specification
Set the Direction => Approved and Definition => Approved and make sure the Series goal is set to the current release. If code is already proposed, set Implementation => Needs Code Review
Optional: add a comment to the Whiteboard explaining the approval, with a date (launchpad does not record approval dates). For example: “We discussed this in the team meeting and agreed to approve this for <release>. – <nick> <YYYYMMDD>”
How to complete a launchpad blueprint¶
Set Implementation => Implemented. The completion date will be recorded by launchpad