USC: Boron: Release Plan

Contents

Release Deliverables

NameDescription

Release Milestones

MilestoneOffset 1 DateDeliverables
M1
NameStatusDescription
Intent to participate'Intent to participate in Beryllium Simultaneous Release
Project Lead elected'USC Project Lead election
Test Contact specified'USC Test Contact announce
Candidate Release Plan'Candidate Release Plan
M2
NameStatusDescription
Release Plan'Final Release Plan
Project Checklist'Project Checklist completed
OpenDaylight CI'OpenDaylight CI infrastructure usage for system test
Project acknowledged'Project acknowledged from all projects that it depends on.
M3
NameStatusDescription
Functionality Freeze
Final list of externally consumable APIs defined and documented
Karaf Features defined
Karaf Features defined
Documentation Started
Identified the kinds of documentation to be provided, created AsciiDoc files for them with outlines,

and committed those files in an appropriate location

Integration & System Test
Simple system test on a karaf distribution with the project's recommended features installed
M4
NameStatus
API Freeze

Draft documentation
Goal of draft documentation done
Maven central requirements
Meet the requirements to be included in maven central
Feature Test Continues
SW configuration and resources required for system test installed
M5
NameStatusDescription
Code Freeze

Stability branch
Stability branch, i.e., stable/beryllium, must be cut and local project versions bumped on master

to avoid overwriting beryllium SNAPSHOTS

String Freeze
All externally visible strings frozen to allow for translation & documentation
Documentation Complete
Only editing and and enhancing should take place after this point.
Feature Test Complete
Feature Test Complete
RC0
NameStatus
Release Candidate 0
RC1
NameStatus
Release Candidate 1
RC2
NameStatus
Release Candidate 2
RC3
NameStatusDescription
Bugfix & more
Bugfixing, performance improvement and other necessary / desired changes
Release Review
Release Review
Release Candidate 3
Formal Release
NameStatusDescription
Formal Beryllium Release

Release patch
Release patch to the stable/beryllium branch and bump versions
SR1 Release
NameStatusDescription
Release patch
Release patch to the stable/beryllium branch and bump versions
SR2 Release
NameStatusDescription
Release patch
Release patch to the stable/beryllium branch and bump versions
SR3 Release
NameStatusDescription
Release patch
Release patch to the stable/beryllium branch and bump versions
SR4 Release
NameStatusDescription
Release patch
Release patch to the stable/beryllium branch and bump versions

Externally Consumable APIs

Short NameDescriptionType (at M2)Type (at M3)Type (release)ContractSupporting Code
usc-channelModel and RPCStableStable
usc/usc-channel-api/src/main/yangorg.opendaylight.usc.channel

Expected Dependencies on Other Projects

Providing ProjectDeliverable NameNeeded ByAcknowledged?Description
org.opendaylight.odlparent.odlparentodlparentM1No
(as link to Other Project Release Plan)
Legacy dependency
org.opendaylight.yangtools.yang-binding,yangtoolsM1No
(as link to Other Project Release Plan)
Legacy dependency
org.opendaylight.controller.netconf-config-dispatchernetconfM1No
(as link to Other Project Release Plan)
Legacy dependency
org.opendaylight.dluxdluxM1No
(as link to Other Project Release Plan)
Legacy dependency

Expected Incompatibilities with Other Projects

Compatibility with Previous Releases

Removed APIs and/or Functionality

Deprecated APIs and/or Functionality

Changed APIs and/or Functionality

Themes and Priorities

Requests from Other Projects

For each API / feature request, the requesting project MUST:

  • open Enhancement bug in Bugzilla describing request with Issue Type: Improvement, Change Request or New Feature
  • create an entry as described in Release Plan - Request template, which will also contain number / link to the bug. After creating the entry, the requesting project MUST:

send an e-mail to release@lists.opendaylight.org (mandated by Simultaneous Release)and both projects' dev lists using this template (mandated by Simultaneous Release)

Requesting ProjectAPI NameNeeded ByAcknowledged?Description
XYZ Projectcall_meM4NoThis is an example to request API supported


Test Tools Requirements

  • Please specify if the project will run System Test (ST) inside OpenDaylight cloud
  • In case affirmative please enumerate any test tool (mininet, etc...) you think will be required for testing your project
    • The goal is to start test tools installation in rackspace as soon as possible
  • In case negative be aware you will be required to provide System Test (ST) reports upon any release creation (weekly Release, Release Candidate, Formal Release, etc...)

Other