search

Azure / azure-sdk-tools

Tools repository leveraged by the Azure SDK team.
MIT License
113 stars 177 forks source link

Notify PM or SDK owner when not release some language SDK #5297

Open zzvswxy opened 1 year ago

zzvswxy commented 1 year ago

Notify PM or SDK owner when service team chose not to release one or more languages SDK. Currently we only record the reason in dataverse. We should send an e-mail or record it in issue or some where.

zzvswxy commented 1 year ago

Hi @josefree , create an issue to track the requirement. We may need more discuss how to achieve it.

maririos commented 1 year ago

@ladonnaq who should we email? you if it is Data lane and Josephine if it is ARM?

ladonnaq commented 10 months ago

@ladonnaq who should we email? you if it is Data lane and Josephine if it is ARM?

Just use the APEX group alias - azsdkapex@microsoft.com. Then we will investigate and get Josephine or others involved if needed.

ladonnaq commented 10 months ago

I will review and look into the requirement for this in Feb 2024. Sending email to the azsdkapex alias will be suitable. Also, want to touch base with Josephine to see if she would like to added to the alias.

maririos commented 2 weeks ago

Looks like it is time to get the requirements here

maririos commented 2 weeks ago

I found official documentation for this process here: https://eng.ms/docs/products/azure-developer-experience/onboard/request-exception @ladonnaq could you follow up on this and make sure @josefree and you are in agreement? Feel free to edit the documentation in case things change.

maririos commented 2 weeks ago

From @josefree:

Please select an appropriate reason for not utilizing the Azure SDK pipeline for the SDK release in a specific language. We (the service owner) allocate resources to develop and deliver the SDK in the specific language manually. We (the service owner) are assured that the service will not be used in a client environment involving the specific language. Others, please specify____

praveenkuttappan commented 1 week ago

From @josefree:

Please select an appropriate reason for not utilizing the Azure SDK pipeline for the SDK release in a specific language. We (the service owner) allocate resources to develop and deliver the SDK in the specific language manually. We (the service owner) are assured that the service will not be used in a client environment involving the specific language. Others, please specify____

I assume we should ask only one attestation for all non-selected languages. We can send an email to azsdkapex@microsoft.com and other service partner parties involved in the release plan.

praveenkuttappan commented 1 week ago

One more question: @ladonnaq and @josefree Can you please confirm if we need this email notification for language exception change for both TypeSpec and OpenAPI based SDK release or only for TypeSpec? We can remove language selection from current management plane SDK release request app and keep it uniform.

praveenkuttappan commented 1 week ago

Solution:

  1. Release planner will prompt user to attest the reason for no choosing a language if any tier 1 language is not selected.
  2. Store this info in Dataverse table along with other information like release plan ID. Add a new column Notified in dataverse and set it to false for attestation records.
  3. Create a cloud flow that gets triggered whenever there is a new attestation record created.
  4. Cloud flow will process the attestation and send an email to azsdkapex@microsoft.com and other service partner parties and mark notified as processed.
ladonnaq commented 1 week ago

One more question: @ladonnaq and @josefree Can you please confirm if we need this email notification for language exception change for both TypeSpec and OpenAPI based SDK release or only for TypeSpec? We can remove language selection from current management plane SDK release request app and keep it uniform.

@praveenkuttappan - As I understand release plans for stable SDKs (generated using TypeSpec or OpenAPI) should include all tier 1 languages and if not, then it would be an exception requiring justification. @josefree Is this your expectation?