search

Azure / azure-sdk-tools

Tools repository leveraged by the Azure SDK team.
MIT License
114 stars 181 forks source link

Redesign of API Readiness App to improve usability and address gaps in engagement experience data model #8063

Open ladonnaq opened 7 months ago

ladonnaq commented 7 months ago

The API readiness milestone app currently requires a user to go through all steps, which is not always necessary. The GitHub toolchain drives the API Review process via the API Spec pull request (PR). The API readiness milestone should be used to validate that the checks and approvers needed to begin the SDK pre-release work have been completed. These checks/approvers should also be requirements to merge the PR.

This work item is related to this epic. https://github.com/Azure/azure-sdk-tools/issues/5670 TODO: Rewrite this issue to reflect the changes we want to make to the API Readiness App to reduce complexity and improve the user experience

Relevant GitHub issues:

Pre-release work:

Management Plane

  1. If new initial SDK, then the SDK package namespaces for each language must be reviewed and approved by the arch board.
  2. .NET SDK must be generated, samples generated, and testing completed. (Dependent upon completion of #1)

Data Plane

  1. If new initial SDK, then the SDK package namespaces for each language must be reviewed and approved by the arch board.
  2. All SDKs must be generated, samples written, and testing completed (Dependent upon completion of #1)

Checks and approvers

In API Readiness today Images show the current checks and approvers in the API readiness milestone

  1. These checks are the same for management and data plane. image
  2. SDK Breaking Changes is only in management plane. In my recent interactions with service partners, they are finding to navigate the PR and figure out what they should address first. I think that if there are breaking changes, we should alert the user in the release planner. If there are no breaking changes, we skip showing them anything. image
  3. The signoff screen is different for data plane vs management plane. image

Gaps in data model

### Tasks
- [ ] Ask the user to provide the API version(s) that will be used to generate the SDKs. @josefree - I will work with you to identify the requirements so that the changes can be made in the API readiness UI and back-end.
maririos commented 7 months ago

Looking into this issue and after conversations with the team, I think it will be beter if we: