Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Release Planner] Add step for validating CODEOWNERS #7351

Open
3 of 8 tasks
ronniegeraghty opened this issue Nov 29, 2023 · 3 comments
Open
3 of 8 tasks

[Release Planner] Add step for validating CODEOWNERS #7351

ronniegeraghty opened this issue Nov 29, 2023 · 3 comments
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. Engagement Experience

Comments

@ronniegeraghty
Copy link
Member

ronniegeraghty commented Nov 29, 2023

We should add a step in the Generate SDKs step of the release planner to have teams validate the CODEOWNERS for their service in each language repo.

Steps for how service partner can do this are located here in the "Getting mentioned on issues" section: https://eng.ms/docs/products/azure-developer-experience/develop/sdk-customer-support

Near-term (June 2024)
Reference the steps to validate and update CODEOWNERS earlier in the UI and Engineering Hub workflow for each release.

Managed Process (June 2024) Reference the steps to validate and update CODEOWNERS earlier in the Release Planner UI and Engineering Hub docs workflow

Preview Give feedback

Optimized Process Requirements (July 2024) Present user with list of current CODEOWNERS for API Spec and each language they plan to release a new SDK version. Allow user to update the contacts. Release Planner App automatically updates the CODEOWNER files.

Preview Give feedback

Optimized Process Implementation (July/Aug 2024) Implement requirements defined in July 2024.

Preview Give feedback
@maririos
Copy link
Member

maririos commented Feb 1, 2024

Copy from issue #7302:

  • The request is to tell people "hey there is this file, make sure someone from your team is added." Is this accurate? do you have a specific message I should use?

Yes. In my ideal scenario we some how check to make sure their service has a valid CODEOWNER listed for each language. Not sure how that type of check would be performed from the release planner.
Here's a sample message you could use:
`To make sure issues and pull request for your libraries are properly routed to your team, add/revalidate code owners for your libraries in each of our language repos. Instructions on this process are located here in the "Getting mentioned on issues" section.

  • Could you remind me here where do we want this to show? is it when they are generating the SDKs? or after they release?

This needs to be before the release and ideally before they open their first PR. Or the changes to CODEOWNERS is in their first PR. I believe this is as they begin generating libraries.

  • This is per language, right?

Yup. They need to do this in each language repo.

  • I am going to link to the document you shared. Anything specific you would like me to add?

Only maybe that the instructions for this task are specifically in the "Getting mentioned on issues" section.

@maririos maririos self-assigned this Jun 18, 2024
@maririos
Copy link
Member

maririos commented Jun 20, 2024

@ladonnaq : I only did the changes in the data plane SDK app because for the API readiness and management plane sdk we need to think more about where should the instructions go:

Image

and the link is pointing to https://aka.ms/azsdk/validate-codeowners
#8479

@maririos
Copy link
Member

@ladonnaq:

  • API Readiness apps: Currently we only ask the user to provide a link to their PR. It will be weird to now also tell them to modify the PR so they add the codewoners file. It feels out of the flow. Do you have recommendations on where it should go?
  • Management plane SDK app: Because the users is not participating in the generation of the SDKs, it feels weird that we are asking them to go open a PR and add your name. As part of generating their SDK, our automation (or vendor team) should also add them to the CODEOWNER file. (except .NET, for .NET we can do that)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team. Engagement Experience
Projects
Status: 🤔 Triage
Status: Backlog
Development

No branches or pull requests

3 participants