Create breakingchange-for-autogen-module

The file contains how to add breaking change or preview message for generated modules.

Author: dolauli

documentation/development-docs/breakingchange-for-autogen-module

@@ -0,0 +1,141 @@
+To add breaking changes and preview messages for cmdlets, there are two scenarios to handle.
+
+- For auto gen cmdlets
+- For customized cmdlets
+
+# For auto gen cmdlets
+
+Breaking changes and preview messages for auto gen cmdlets are added through directives in readme.md. And following are some common cases.
+
+## Case 1 — Module is deprecated
+
+ 
+
+```yaml
+- where:
+      verb: (.*)
+    set:
+      breaking-change:
+        deprecated-by-version: 5.0.0
+        change-effective-date: 2055/10/30
+```
+
+## Case 2 — Breaking change for a cmdlet
+
+```yaml
+- where:
+      verb: New
+      subject: VNetPeering
+    set:
+      breaking-change:
+        replacement-cmdlet: New-AzNewVNetPeering
+        deprecated-by-version: 5.0.0
+        change-effective-date: 2022/05/30
+```
+
+## Case 3 — Breaking change for multiple cmdlets
+
+```yaml
+- where:
+      subject: VNetPeering
+    set:
+      breaking-change:
+        replacement-cmdlet: $.replace("VNetPeering", "VNewNetPeering")
+        deprecated-by-version: 5.0.0
+        change-effective-date: 2022/05/30
+```
+
+## Case 4 — Breaking change for an output type
+
+```yaml
+- where:
+      verb: New
+      subject: VNetPeering
+    set:
+      breaking-change:
+        deprecated-cmdlet-output-type: oldtype
+        replacement-cmdlet-output-type: newtype
+        deprecated-output-properties:
+          - propertyA
+          - PropertyB
+        new-output-properties:
+          - PropertyC
+          - PropertyD
+        change-description: This is a custom message for the change.
+        deprecated-by-version: 5.0.0
+        change-effective-date: 2022/05/11
+```
+
+## Case 5 — Breaking change for parameter sets(variants)
+
+```yaml
+- where:
+      verb: Remove
+      subject: VNetPeering
+      variant: Delete
+    set:
+      breaking-change:
+				deprecated-by-version: 5.0.0
+        change-efective-date: 2022/05/30
+```
+
+## Case 6 — Breaking change for a parameter
+
+```yaml
+- where:
+      parameter-name: Sku
+    set:
+      breaking-change:
+        old-parameter-type: int
+        new-parameter-type: boolean
+        become-mandatory: true
+        change-description: This is a custom message for the change.
+        deprecated-by-version: 5.0.0
+        change-efective-date: 2022/05/30
+```
+
+## Case 7 — Preview message
+
+```yaml
+- where:
+      verb: New
+      subject: VNetPeering
+    set:
+      preview-message: This is a test preview message.
+```
+
+# For customized cmdlets
+
+To add breaking changes or preview messages for a customized cmdlets, you will need to add related attributes in code directly. And following are some common cases.
+
+**Note: For Case 1/2/3/5, the attributes are applied on the functions. For case 5, the attribute is applied in the parameter. And these examples are based on the databricks module, so you will need to replace it with your module name.**
+
+## Case 1 — Breaking change for a cmdlet
+
+```csharp
+[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.CmdletBreakingChangeAttribute("4.0", "2022/05/30", ReplacementCmdletName = 'replace-xxx')
+```
+
+## Case 2 — Breaking change for parameter sets(variants)
+
+```csharp
+[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.ParameterSetBreakingChangeAttribute(("parametersetname1", "parametersetname2"), "4.0", "2022/05/30")]
+```
+
+## Case 3 — Breaking change for an output type
+
+```csharp
+[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.OutputBreakingChange("oldtype", "5.0.0", "2022/05/11", ReplacementCmdletOutputType = "newtype", DeprecatedOutputProperties = ("propertyA", "PropertyB"), NewOutputProperties = ("PropertyC", "PropertyD"))]
+```
+
+## Case 4 — Breaking change for a parameter
+
+```csharp
+[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.ParameterBreakingChangeAttribute("ResourceGroupName", "4.1", "2028/06/18")]
+```
+
+## Case 5 — Preview message
+
+```csharp
+[Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.PreviewMessageAttribute("This is a preview version")]
+```