[Pipeline] add parameter to skip changelog generation if needed - #42220
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds functionality to conditionally skip changelog generation in the SDK generator pipeline by introducing an optional enableChangelog parameter. When set to False, the changelog generation step is bypassed, which can be useful for automated processes or specific scenarios where changelog generation is not needed.
| if data.get("enableChangelog", True): | ||
| md_output = execute_func_with_timeout(change_log_func) | ||
| else: | ||
| md_output = "skip changelog generation" |
There was a problem hiding this comment.
The hardcoded string "skip changelog generation" should be replaced with a more descriptive constant or a structured response that better indicates the intentional skip. Consider using a constant like CHANGELOG_SKIPPED_MESSAGE or a more informative message.
| md_output = "skip changelog generation" | |
| md_output = CHANGELOG_SKIPPED_MESSAGE |
| @@ -368,7 +368,10 @@ def main(generate_input, generate_output): | |||
|
|
|||
| changelog_generation_start_time = time.time() | |||
| try: | |||
There was a problem hiding this comment.
The new enableChangelog parameter lacks documentation. Consider adding a comment explaining the purpose and expected behavior when this parameter is set to False, especially since it affects the changelog generation workflow.
| try: | |
| try: | |
| # The `enableChangelog` parameter determines whether the changelog generation process is executed. | |
| # If set to False, the changelog generation is skipped, and a placeholder message is used instead. | |
| # By default, this parameter is True, ensuring that changelogs are generated unless explicitly disabled. |
No description provided.