Skip to content
Snippets Groups Projects

Release Strategy

Last edited by Marc Burnie

Table of Content

Versioning Strategy

The overall versioning strategy proposal and process for OSDU milestone release.

PMC Portal

Latest version of the strategy document

Common OSDU CI/CD Pipeline

Patch Process

Dev Environments

Current planned dates for upcoming OSDU milestone releases

Note that the dates below might change depending on various reasons, announcement will be made in PMC Slack channel for further communication

🐌 Updated Mercury Release Cadence starting M23 as announced in the 31-Jan-2024 Focal Point meeting

Milestones Code Dev Start Feature Freeze Code Tagging Start Code Tagging Completed Deployed to Pre Shipping Public Release
M25 26-Jul-24 8-Nov-24 17-Jan-25 14-Feb-25 15-Nov-24 24-Jan-25 21-Feb-25 29-Nov-24 7-Feb-25 7-Mar-25 06-Dec-24 14-Feb-25 14-Mar-25 17-Jan-25 28-Mar-25 25-Apr-25

Previous dates for OSDU milestone releases (in descending order of dates)

Milestones Code Dev Start Feature Freeze Code Tagging Start Code Tagging Completed Deployed to Pre Shipping Public Release
M24 05-Apr-24 19-Jul-24 26-Jul-24 09-Aug-24 6-Sep-24 03-Oct-24
M23 08-Dec-23 29-Mar-24 05-Apr-24 19-Apr-24 26-Apr-24 24-May-24
M22 13-Oct-23 01-Dec-23 08-Dec-23 15-Dec-23 22-Dec-23 30-Jan-24
M21 25-Aug-23 06-Oct-23 13-Oct-23 20-Oct-23 27-Oct-23 23-Nov-23
M20 07-Jul-23 18-Aug-23 25-Aug-23 06-Sep-23 08-Sep-23 29-Sep-23
M19 19-May-23 30-Jun-23 07-Jul-23 18-Jul-23 21-Jul-23 11-Aug-23
M18 31-Mar-23 12-May-23 19-May-23 31-May-23 02-Jun-23 27-Jun-23
M17 03-Feb-23 17-Mar-23 31-Mar-23 13-Apr-23 19-Apr-23 10-May-23
M16 02-Dec-22 27-Jan-23 03-Feb-23 17-Feb-23 22-Feb-23 15-Mar-23
M15 30-Sep-22 11-Nov-22 02-Dec-22 13-Dec-22 16-Dec-22 13-Jan-23
M14 04-Aug-22 23-Sep-22 30-Sep-22 07-Oct-22 14-Oct-22 09-Nov-22
M13 27-May-22 22-Jul-22 04-Aug-22 12-Aug-22 19-Aug-22 09-Sep-22
M12 28-Mar-22 20-May-22 27-May-22 24-Jun-22 28-Jun-22 12-Jul-22
M11 21-Jan-22 18-Mar-22 28-Mar-22 01-Apr-22 15-Apr-22 03-May-22
M10 Patch 11-Mar-22 18-Mar-22 18-Mar-22 25-Mar-22
M10 22-Oct-21 14-Jan-22 21-Jan-22 28-Jan-22 11-Feb-22 04-Mar-22
M9 27-Aug-21 15-Oct-21 22-Oct-21 29-Oct-21 12-Nov-21 10-Dec-21
M8 16-Jul-21 27-Aug-21 03-Sep-21 17-Sep-21 30-Sep-21
M7 28-May-21 16-Jul-21 30-Jul-21 20-Aug-21
M6 30-Apr-21 28-May-21 02-Jul-21
M5 05-Mar-21 30-Apr-21
M4 12-Feb-21 05-Mar-21
M3 25-Jan-21 12-Feb-21
M1 26-Apr-20 25-Jan-21

Release Branches

Each release of OSDU libraries and services will have a major/minor version pair (such as "1.0") that represents the release. Release numbers that match across different services are meant to be considered a package -- that is, they were released at the same time. The specific numbers in the version are increased with each release (in the normal way), but importantly are not synchronized to any other milestone name, including monikers such as "R3" or "M1".

These releases are created as branches with the prefix release/ so that the release can be updated with additional patches later. Patches of this nature will not introduce new features but only apply bug fixes or minor updates.

Tags

Each release branch will contain tag(s) once the release process is completed. The tags are immutable and they point to a specific commit in the release branch. In general, there is one for each patch released under that version. The tags will be named with a v prefix and will repeat the version number (such as "v1.0.0"). All release branches will have at least a ".0" patch but may gain additional tags if patches are applied after branch creation. The version number 0.X refers to the version of the OSDU Data Platform and can be accessed via the /info API endpoint in core services.

For CSP-specific patches following the release, we will denote a CSP-specific tag, e.g. v0.23.0-azure.1. This contains similar common code as v0.23.0 but with additional changes made on the CSP-specific SPI layer.

All QA and pre-shipping deployments are made using the tags to ensure alignment and consistency.

Tagging Notes

These pages are generated by scripts to report the status of the tagging process. They are mostly relevant to the developers while releases are being prepared.

Release Notes

Development timeline for milestones

Each OSDU milestone starts with about 1.5 months of development, followed by the checkpoints of Feature Freeze, Code Tagging Start, Code Tagging Completed, deployment into both QA and pre-shipping environment by CSP teams, and 3 weeks validation in pre-shipping environment.

Release Process

Please note that:

  • Feature Freeze is the target date for the completion of feature development on common code. No new feature should be planned and developed for this milestone release after this date.
  • Between Feature Freeze and Code Tagging Start:
    • No new features should be developed but existing merge requests (MRs) can still be merged if pending reviews and approvals
    • Only bug fixes, CSP-specific changes, stabilizing pipeline
  • On the day of Code Tagging Start, the release branch is forked from the default (main/master) branch. Any new feature/code development in the default branch now goes towards the next milestone release. Release coordinator completes the code tagging.
  • As soon as code tagging is completed, the tags are deployed to the QA/Testing Platform Validation environment.
  • Deployed to Pre Shipping date is the target date for CSP teams to complete deployment of the tagged milestone baseline into pre-shipping environment so that pre-shipping team is able to execute UAT.
  • Public Release date is after the confirmation and validation from pre-shipping team. The date may change depending on the validation results.

You may find additional notes about "CSP deployment to QA/Testing (aka "Platform Validation") and Preship environments" in this document. https://gitlab.opengroup.org/osdu/pmc/docs/-/blob/master/Planning/OSDU_Community_Milestone_Release_Process.docx

Comments

    Please register or sign in to add a comment.