Skip to content

Commit 6752ba0

Browse files
msyycmsyyc
authored
[breaking change detector] optimize changelog template (Azure#37173)
* optimize changelog template * fix for template * fix for test
1 parent 843055a commit 6752ba0

File tree

3 files changed

+65
-65
lines changed

3 files changed

+65
-65
lines changed

‎scripts/breaking_changes_checker/breaking_changes_tracker.py‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -36,57 +36,57 @@ class BreakingChangeType(str, Enum):
3636

3737
class BreakingChangesTracker:
3838
REMOVED_OR_RENAMED_CLIENT_MSG = \
39-
"Deleted or renamed client '{}'"
39+
"Deleted or renamed client `{}`"
4040
REMOVED_OR_RENAMED_CLIENT_METHOD_MSG = \
41-
"Deleted or renamed client method '{}.{}'"
41+
"Deleted or renamed client method `{}.{}`"
4242
REMOVED_OR_RENAMED_CLASS_MSG = \
43-
"Deleted or renamed model '{}'"
43+
"Deleted or renamed model `{}`"
4444
REMOVED_OR_RENAMED_CLASS_METHOD_MSG = \
45-
"Deleted or renamed method '{}.{}'"
45+
"Deleted or renamed method `{}.{}`"
4646
REMOVED_OR_RENAMED_MODULE_LEVEL_FUNCTION_MSG = \
47-
"Deleted or renamed function '{}'"
47+
"Deleted or renamed function `{}`"
4848
REMOVED_OR_RENAMED_POSITIONAL_PARAM_OF_METHOD_MSG = \
49-
"'{}.{}' method deleted or renamed its parameter '{}' of kind '{}'"
49+
"Method `{}.{}` deleted or renamed its parameter `{}` of kind `{}`"
5050
REMOVED_OR_RENAMED_POSITIONAL_PARAM_OF_FUNCTION_MSG = \
51-
"'{}' function deleted or renamed its parameter '{}' of kind '{}'"
51+
"Function `{}` deleted or renamed its parameter `{}` of kind `{}`"
5252
ADDED_POSITIONAL_PARAM_TO_METHOD_MSG = \
53-
"'{}.{}' method inserted a '{}' parameter '{}'"
53+
"Method `{}.{}` inserted a `{}` parameter `{}`"
5454
ADDED_POSITIONAL_PARAM_TO_FUNCTION_MSG = \
55-
"'{}' function inserted a '{}' parameter '{}'"
55+
"Function `{}` inserted a `{}` parameter `{}`"
5656
REMOVED_OR_RENAMED_INSTANCE_ATTRIBUTE_FROM_CLIENT_MSG = \
57-
"'{}' deleted or renamed client instance variable '{}'"
57+
"Client `{}` deleted or renamed instance variable `{}`"
5858
REMOVED_OR_RENAMED_INSTANCE_ATTRIBUTE_FROM_MODEL_MSG = \
59-
"'{}' model deleted or renamed its instance variable '{}'"
59+
"Model `{}` deleted or renamed its instance variable `{}`"
6060
REMOVED_OR_RENAMED_ENUM_VALUE_MSG = \
61-
"Deleted or renamed enum value '{}.{}'"
61+
"Deleted or renamed enum value `{}.{}`"
6262
CHANGED_PARAMETER_DEFAULT_VALUE_MSG = \
63-
"'{}.{}' method parameter '{}' changed default value from '{}' to '{}'"
63+
"Method `{}.{}` parameter `{}` changed default value from `{}` to `{}`"
6464
CHANGED_PARAMETER_DEFAULT_VALUE_OF_FUNCTION_MSG = \
65-
"'{}' function parameter '{}' changed default value from '{}' to '{}'"
65+
"Function `{}` parameter `{}` changed default value from `{}` to `{}`"
6666
REMOVED_PARAMETER_DEFAULT_VALUE_MSG = \
67-
"'{}.{}' removed default method value '{}' from its parameter '{}'"
67+
"Method `{}.{}` removed default value `{}` from its parameter `{}`"
6868
REMOVED_PARAMETER_DEFAULT_VALUE_OF_FUNCTION_MSG = \
69-
"'{}' function removed default value '{}' from its parameter '{}'"
69+
"Function `{}` removed default value `{}` from its parameter `{}`"
7070
CHANGED_PARAMETER_ORDERING_MSG = \
71-
"'{}.{}' method re-ordered its parameters from '{}' to '{}'"
71+
"Method `{}.{}` re-ordered its parameters from `{}` to `{}`"
7272
CHANGED_PARAMETER_ORDERING_OF_FUNCTION_MSG = \
73-
"'{}' function re-ordered its parameters from '{}' to '{}'"
73+
"Function `{}` re-ordered its parameters from `{}` to `{}`"
7474
CHANGED_PARAMETER_KIND_MSG = \
75-
"'{}.{}' method changed its parameter '{}' from '{}' to '{}'"
75+
"Method `{}.{}` changed its parameter `{}` from `{}` to `{}`"
7676
CHANGED_PARAMETER_KIND_OF_FUNCTION_MSG = \
77-
"'{}' function changed its parameter '{}' from '{}' to '{}'"
77+
"Function `{}` changed its parameter `{}` from `{}` to `{}`"
7878
CHANGED_CLASS_FUNCTION_KIND_MSG = \
79-
"'{}.{}' method changed from '{}' to '{}'"
79+
"Method `{}.{}` changed from `{}` to `{}`"
8080
CHANGED_FUNCTION_KIND_MSG = \
81-
"Changed function '{}' from '{}' to '{}'"
81+
"Changed function `{}` from `{}` to `{}`"
8282
REMOVED_OR_RENAMED_MODULE_MSG = \
83-
"Deleted or renamed module '{}'"
83+
"Deleted or renamed module `{}`"
8484
REMOVED_CLASS_FUNCTION_KWARGS_MSG = \
85-
"'{}.{}' method changed from accepting keyword arguments to not accepting them"
85+
"Method `{}.{}` changed from accepting keyword arguments to not accepting them"
8686
REMOVED_FUNCTION_KWARGS_MSG = \
87-
"'{}' function changed from accepting keyword arguments to not accepting them"
87+
"Function `{}` changed from accepting keyword arguments to not accepting them"
8888
REMOVED_OR_RENAMED_OPERATION_GROUP_MSG = \
89-
"Deleted or renamed client operation group '{}.{}'"
89+
"Deleted or renamed client operation group `{}.{}`"
9090

9191
def __init__(self, stable: Dict, current: Dict, package_name: str, **kwargs: Any) -> None:
9292
self.stable = stable

‎scripts/breaking_changes_checker/changelog_tracker.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,21 @@ class ChangeType(str, Enum):
2323

2424
class ChangelogTracker(BreakingChangesTracker):
2525
ADDED_CLIENT_MSG = \
26-
"Added client '{}'"
26+
"Added client `{}`"
2727
ADDED_CLIENT_METHOD_MSG = \
28-
"Client '{}' added method '{}'"
28+
"Client `{}` added method `{}`"
2929
ADDED_CLASS_MSG = \
30-
"Added model '{}'"
30+
"Added model `{}`"
3131
ADDED_CLASS_METHOD_MSG = \
32-
"Model '{}' added method '{}'"
32+
"Model `{}` added method `{}`"
3333
ADDED_CLASS_METHOD_PARAMETER_MSG = \
34-
"Model '{}' added parameter '{}' in the '{}' method"
34+
"Model `{}` added parameter `{}` in method `{}`"
3535
ADDED_FUNCTION_PARAMETER_MSG = \
36-
"Function '{}' added parameter '{}'"
36+
"Function `{}` added parameter `{}`"
3737
ADDED_CLASS_PROPERTY_MSG = \
38-
"Model '{}' added property '{}'"
38+
"Model `{}` added property `{}`"
3939
ADDED_OPERATION_GROUP_MSG = \
40-
"Client '{}' added operation group '{}'"
40+
"Client `{}` added operation group `{}`"
4141

4242

4343
def __init__(self, stable: Dict, current: Dict, package_name: str, **kwargs: Any) -> None:

‎scripts/breaking_changes_checker/tests/test_breaking_changes.py‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,25 @@ def format_breaking_changes(breaking_changes):
2323
return formatted
2424

2525
EXPECTED = [
26-
"(RemovedOrRenamedInstanceAttribute): 'Metrics' model deleted or renamed its instance variable 'retention_policy'",
27-
"(RemovedOrRenamedInstanceAttribute): 'QueueClient' deleted or renamed client instance variable 'queue_name'",
28-
"(ChangedParameterKind): 'QueueClient.from_queue_url' method changed its parameter 'credential' from 'positional_or_keyword' to 'keyword_only'",
29-
"(AddedPositionalParam): 'QueueClient.get_queue_access_policy' method inserted a 'positional_or_keyword' parameter 'queue_name'",
30-
"(RemovedOrRenamedPositionalParam): 'QueueClient.set_queue_access_policy' method deleted or renamed its parameter 'signed_identifiers' of kind 'positional_or_keyword'",
31-
"(ChangedParameterDefaultValue): 'QueueClient.set_queue_metadata' method parameter 'metadata' changed default value from 'None' to ''",
32-
"(RemovedOrRenamedClassMethod): Deleted or renamed method 'QueueSasPermissions.from_string'",
33-
"(RemovedFunctionKwargs): 'QueueServiceClient.set_service_properties' method changed from accepting keyword arguments to not accepting them",
34-
"(RemovedOrRenamedClientMethod): Deleted or renamed client method 'QueueServiceClient.get_service_properties'",
35-
"(RemovedOrRenamedEnumValue): Deleted or renamed enum value 'StorageErrorCode.queue_not_found'",
36-
"(RemovedOrRenamedClass): Deleted or renamed model 'QueueMessage'",
37-
"(ChangedParameterDefaultValue): 'generate_queue_sas' function parameter 'permission' changed default value from 'None' to ''",
38-
"(ChangedParameterKind): 'generate_queue_sas' function changed its parameter 'ip' from 'positional_or_keyword' to 'keyword_only'",
39-
"(AddedPositionalParam): 'generate_queue_sas' function inserted a 'positional_or_keyword' parameter 'conn_str'",
40-
"(RemovedOrRenamedPositionalParam): 'generate_queue_sas' function deleted or renamed its parameter 'account_name' of kind 'positional_or_keyword'",
41-
"(RemovedOrRenamedModuleLevelFunction): Deleted or renamed function 'generate_account_sas'",
42-
"(RemovedParameterDefaultValue): 'QueueClient.update_message' removed default method value 'None' from its parameter 'pop_receipt'",
43-
"(ChangedFunctionKind): 'QueueServiceClient.get_service_stats' method changed from 'asynchronous' to 'synchronous'",
44-
"(ChangedParameterOrdering): 'QueueClient.from_connection_string' method re-ordered its parameters from '['conn_str', 'queue_name', 'credential', 'kwargs']' to '['queue_name', 'conn_str', 'credential', 'kwargs']'",
26+
"(RemovedOrRenamedInstanceAttribute): Model `Metrics` deleted or renamed its instance variable `retention_policy`",
27+
"(RemovedOrRenamedInstanceAttribute): Client `QueueClient` deleted or renamed instance variable `queue_name`",
28+
"(ChangedParameterKind): Method `QueueClient.from_queue_url` changed its parameter `credential` from `positional_or_keyword` to `keyword_only`",
29+
"(AddedPositionalParam): Method `QueueClient.get_queue_access_policy` inserted a `positional_or_keyword` parameter `queue_name`",
30+
"(RemovedOrRenamedPositionalParam): Method `QueueClient.set_queue_access_policy` deleted or renamed its parameter `signed_identifiers` of kind `positional_or_keyword`",
31+
"(ChangedParameterDefaultValue): Method `QueueClient.set_queue_metadata` parameter `metadata` changed default value from `None` to ``",
32+
"(RemovedOrRenamedClassMethod): Deleted or renamed method `QueueSasPermissions.from_string`",
33+
"(RemovedFunctionKwargs): Method `QueueServiceClient.set_service_properties` changed from accepting keyword arguments to not accepting them",
34+
"(RemovedOrRenamedClientMethod): Deleted or renamed client method `QueueServiceClient.get_service_properties`",
35+
"(RemovedOrRenamedEnumValue): Deleted or renamed enum value `StorageErrorCode.queue_not_found`",
36+
"(RemovedOrRenamedClass): Deleted or renamed model `QueueMessage`",
37+
"(ChangedParameterDefaultValue): Function `generate_queue_sas` parameter `permission` changed default value from `None` to ``",
38+
"(ChangedParameterKind): Function `generate_queue_sas` changed its parameter `ip` from `positional_or_keyword` to `keyword_only`",
39+
"(AddedPositionalParam): Function `generate_queue_sas` inserted a `positional_or_keyword` parameter `conn_str`",
40+
"(RemovedOrRenamedPositionalParam): Function `generate_queue_sas` deleted or renamed its parameter `account_name` of kind `positional_or_keyword`",
41+
"(RemovedOrRenamedModuleLevelFunction): Deleted or renamed function `generate_account_sas`",
42+
"(RemovedParameterDefaultValue): Method `QueueClient.update_message` removed default value `None` from its parameter `pop_receipt`",
43+
"(ChangedFunctionKind): Method `QueueServiceClient.get_service_stats` changed from `asynchronous` to `synchronous`",
44+
"(ChangedParameterOrdering): Method `QueueClient.from_connection_string` re-ordered its parameters from `['conn_str', 'queue_name', 'credential', 'kwargs']` to `['queue_name', 'conn_str', 'credential', 'kwargs']`",
4545
]
4646

4747

@@ -177,10 +177,10 @@ def test_replace_all_params():
177177
}
178178

179179
EXPECTED = [
180-
"(RemovedOrRenamedPositionalParam): 'class_name.one' method deleted or renamed its parameter 'testing' of kind 'positional_or_keyword'",
181-
"(RemovedOrRenamedPositionalParam): 'class_name.two' method deleted or renamed its parameter 'testing2' of kind 'positional_or_keyword'",
182-
"(RemovedOrRenamedPositionalParam): 'my_function_name' function deleted or renamed its parameter 'testing' of kind 'positional_or_keyword'",
183-
"(RemovedOrRenamedPositionalParam): 'my_function_name' function deleted or renamed its parameter 'testing2' of kind 'positional_or_keyword'"
180+
"(RemovedOrRenamedPositionalParam): Method `class_name.one` deleted or renamed its parameter `testing` of kind `positional_or_keyword`",
181+
"(RemovedOrRenamedPositionalParam): Method `class_name.two` deleted or renamed its parameter `testing2` of kind `positional_or_keyword`",
182+
"(RemovedOrRenamedPositionalParam): Function `my_function_name` deleted or renamed its parameter `testing` of kind `positional_or_keyword`",
183+
"(RemovedOrRenamedPositionalParam): Function `my_function_name` deleted or renamed its parameter `testing2` of kind `positional_or_keyword`"
184184
]
185185

186186
bc = BreakingChangesTracker(stable, current, "azure-storage-queue")
@@ -264,10 +264,10 @@ def test_replace_all_functions():
264264
}
265265

266266
EXPECTED = [
267-
"(RemovedOrRenamedClassMethod): Deleted or renamed method 'class_name.one'",
268-
"(RemovedOrRenamedClassMethod): Deleted or renamed method 'class_name.two'",
269-
"(RemovedOrRenamedModuleLevelFunction): Deleted or renamed function 'my_function_name'",
270-
"(RemovedOrRenamedModuleLevelFunction): Deleted or renamed function 'my_function_name2'"
267+
"(RemovedOrRenamedClassMethod): Deleted or renamed method `class_name.one`",
268+
"(RemovedOrRenamedClassMethod): Deleted or renamed method `class_name.two`",
269+
"(RemovedOrRenamedModuleLevelFunction): Deleted or renamed function `my_function_name`",
270+
"(RemovedOrRenamedModuleLevelFunction): Deleted or renamed function `my_function_name2`"
271271
]
272272

273273
bc = BreakingChangesTracker(stable, current, "azure-storage-queue")
@@ -339,8 +339,8 @@ def test_replace_all_classes():
339339
}
340340

341341
EXPECTED = [
342-
"(RemovedOrRenamedClass): Deleted or renamed model 'class_name'",
343-
"(RemovedOrRenamedClass): Deleted or renamed model 'class_name2'"
342+
"(RemovedOrRenamedClass): Deleted or renamed model `class_name`",
343+
"(RemovedOrRenamedClass): Deleted or renamed model `class_name2`"
344344
]
345345

346346
bc = BreakingChangesTracker(stable, current, "azure-storage-queue")
@@ -366,7 +366,7 @@ def test_replace_all_modules():
366366
}
367367

368368
EXPECTED = [
369-
"(RemovedOrRenamedModule): Deleted or renamed module 'azure.ai.formrecognizer'",
369+
"(RemovedOrRenamedModule): Deleted or renamed module `azure.ai.formrecognizer`",
370370
]
371371

372372
bc = BreakingChangesTracker(stable, current, "azure-storage-queue")
@@ -422,7 +422,7 @@ def test_removed_operation_group():
422422
}
423423

424424
EXPECTED = [
425-
"(RemovedOrRenamedOperationGroup): Deleted or renamed client operation group 'ContosoClient.foo'"
425+
"(RemovedOrRenamedOperationGroup): Deleted or renamed client operation group `ContosoClient.foo`"
426426
]
427427

428428
bc = BreakingChangesTracker(stable, current, "azure-storage-queue")

0 commit comments

Comments
 (0)