Repository navigation
Versioning strategy for Graph extension #72
Jason Dou (jason-dou)
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Creating this thread to discuss and seek feedback for the Graph extension versioning strategy. Feel free to share your thoughts!
Overview
Currently, in Bicep compiler, the Graph extension/provider is imported in the Bicep templates via the statement
provider 'microsoftGraph@1.0.0', wheremicrosoftGraphis a single extension and the version is a placeholder hardcoded as1.0.0. This brings two problems:We plan to address the above issues with a versioning strategy for the Graph extension by utilizing the dynamic type loading feature, so you can choose the provider version for the templates.
Versioning
With dynamic type loading, extensions will be distributed using OCI registry (Azure/bicep#12111).
We plan to have two Graph type providers:
microsoftGraphV1.0:a.b.candmicrosoftGraphBeta:x.y.z. Only resources in v1.0 are inmicrosoftGraphV1.0, and only resources in beta are inmicrosoftGraphBeta. Versiona.b.candx.y.zincrement independently and both follow the version semantics in the Version format and schema section.You can use Graph types with the following import statements in your Bicep templates:
Version format and schema
The version format will be in a semantic format like
x.y.z, following this comment Proposal: Versioning of provider artifacts and provider resources · Azure/bicep · Discussion #11894 (github.com). The rules to increment the version numbers are the following:Version number Z accounts for minor or patch modifications to Graph resource types that do not introduce breaking changes. It should be incremented by 1 under the following circumstances:
A new Graph resource type is added.
A new property is added to an existing Graph resource type.
A new API version of an existing Graph resource type is introduced.
Version number Y addresses breaking changes related to Graph resource types. It should be incremented by 1 under the following circumstances:
Any of the existing Graph resource types undergoes modifications that breaks the existing contract, including
The removal of an existing property
The addition of a required property
Changing the type of an existing property
Narrowing the range of the possible values of an existing property
Any of the existing resource types are removed.
Version number X represents significant changes in the Graph API or Bicep resource types.
All reactions