...
- User driven
- Users refers specifically to WMDA member registries (or their delegates) that currently use or intend to use the Match-Connect apisAPIs
- During the early design and implementation phases of Match-Connect, features will be proposed by the Match-Connect Steering Committee and participating pilot registries
- Following the pilot phase, all user driven features will be requested via the Match-Connect User Group RFC Process
- Implementation team driven
- Implementation team refers to the technical staff of the WMDA and their associates that are directly involved in the implementation of the Match-Connect apisAPIs
- The implementation team may need to include items in a release to resolve defects, improve underlying design, update dependencies / libraries and to keep the software in good, working order
...
Whether user driven or implementation team driven, proposed features with user impact and/or those requiring significant internal resources will be logged in the WMDA Share under the Match-Connect Release Management page as part of a release candidate package. In the immediate term, the Match-Connect Steering Committee will assist with determination of impact and effort in order to assign features to a given release candidate. Each candidate feature will be given a disposition (Approved, Rejected, moved to RFC). Implementation actions (updating code, updating the semantics, updating swagger, etc) will be recorded on the release candidate page and tracked for completion.
The implementation team will leverage Azure Dev Ops for more detailed tracking of their software development work. The Match-Connect Product Owner will take responsibility for ensuring synchronization of feature inclusion into the detailed work items in Azure Dev Ops.
...
- Minor = cosmetic or wording only
- Moderate = api API change
- Major = significant behavioral change
...
The following snapshot is pulled from the MC v1.01 Release Candidate.
Versioning
The semantic versioning scheme will be utilized for Match-Connect releases going forward. It can be summarized as follows:
...
Following the pilot, we will align the versioning of the semantics with the public versioning of the apis APIs and keep them in step going forward. In the meantime, a change log (manifest) will be used to tie the versions of the semantics and the apis APIs together.
Breaking Changes
...
| PlantUML Macro |
|---|
@startgantt
<style>
ganttDiagram {
task {
BackGroundColor dodgerblue
FontColor white
}
}
</style>
title Major Releases of Match-Connect APIs (example schedule)
projectscale weekly
project starts 2025-05-15
[i] lasts 1 day
[Community informed of major release (e.g. Spring Mtg)] as [ci] happens at [i]'s end
[ci] displays on same row as [i]
[WMDA develops new APIs] as [WMDA dev] lasts 120 days
[New APIs deployed to test] as [test] happens at [WMDA dev]'s end
[Community preparation, development and testing] as [comm prep] lasts 180 days
[Community ready to receive via new apis (e.g. Fall Mtg)] as [comm rec] happens at [comm prep]'s end
[Deploy] as [prod] lasts 14 days
[prod] starts after [comm rec]'s end
[Community may send using new APIs] as [new] happens at [prod]'s end
[Old / New APIs] as [both] lasts 30 days
[both] starts after [new]'s end
[Old APIs deprecated] as [dep] happens after [both]'s end
[End] happens 270 days after [ci]'s end
@endgantt |
...