Skip to content

Instantly share code, notes, and snippets.

@raych1

raych1/Sdk-breakingchange-labels.md Secret

Last active April 23, 2024 03:16
Show Gist options
  • Save raych1/353949d19371b69fb82a10dd70032a51 to your computer and use it in GitHub Desktop.
Save raych1/353949d19371b69fb82a10dd70032a51 to your computer and use it in GitHub Desktop.
Download ZIP
The labels used in the SDK breaking change review workflow and suppression flow
Raw
Sdk-breakingchange-labels.md

Existing labels

CI-BreakingChange-Go

  • This label is added by SDK automation tool when a breaking change is detected in a new GA version of Go SDK package, compared to a previously released GA package.
  • The PR merge is blocked until a "Approved-SdkBreakingChange-Go" label is applied.

CI-BreakingChange-JavaScript

  • This label is added by SDK automation tool when a breaking change is detected in a new GA version of JavaScript SDK package, compared to a previously released GA package.
  • The PR merge is blocked until a "Approved-SdkBreakingChange-JavaScript" label is applied.

CI-BreakingChange-Python

  • This label is added by SDK automation tool when a breaking change is detected in a new GA version of Python SDK package, compared to a previously released GA package.
  • The PR merge is blocked until a "Approved-SdkBreakingChange-Python" label is applied.

CI-BreakingChange-Python-Track2

  • This label is added by SDK automation tool when a breaking change is detected in a new GA version Python Track2 SDK package, compared to a previously released GA package.
  • The PR merge is blocked until a "Approved-SdkBreakingChange-Python" label is applied.

Approved-SdkBreakingChange-Go, Approved-SdkBreakingChange-JavaScript, Approved-SdkBreakingChange-Python

  • These labels should be added by the SDK breaking change reviewers.

New labels

BreakingChange-Go-Sdk

  • To replace CI-BreakingChange-Go.

BreakingChange-JavaScript-Sdk

  • To replace CI-BreakingChange-JavaScript.

BreakingChange-Python-Sdk

  • To replace CI-BreakingChange-Python.

BreakingChange-Python-Track2-Sdk

  • To replace CI-BreakingChange-Python-Track2.

BreakingChange-Go-Sdk-Approved

  • To replace Approved-SdkBreakingChange-Go.

BreakingChange-JavaScript-Sdk-Approved

  • To replace Approved-SdkBreakingChange-JavaScript.

BreakingChange-Python-Sdk-Approved

  • To replace Approved-SdkBreakingChange-Python.

BreakingChange-Go-Sdk-Suppression

  • This label is added by automation tool when a pull request includes the change of Go Sdk suppressions.
  • The PR merge is blocked until a BreakingChange-Go-Sdk-Suppression-Approved label is added.

BreakingChange-JavaScript-Sdk-Suppression

  • This label is added by automation tool when a pull request includes the change of JavaScript Sdk suppressions.
  • The PR merge is blocked until a BreakingChange-JavaScript-Sdk-Suppression-Approved label is added.

BreakingChange-Python-Sdk-Suppression

  • This label is added by automation tool when a pull request includes the change of Python Sdk suppressions.
  • The PR merge is blocked until a BreakingChange-Python-Sdk-Suppression-Approved label is added.

BreakingChange-Go-Sdk-Suppression-Approved

  • This label should be added by the Go SDK breaking change reviewers.

BreakingChange-JavaScript-Sdk-Suppression-Approved

  • This label should be added by the JavaScript SDK breaking change reviewers.

BreakingChange-Python-Sdk-Suppression-Approved

  • This label should be added by the Python SDK breaking change reviewers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment