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

[PR Workflow] Use more labels for new TypeSpec identification #7216

Open
allenjzhang opened this issue Oct 31, 2023 · 9 comments
Open

[PR Workflow] Use more labels for new TypeSpec identification #7216

allenjzhang opened this issue Oct 31, 2023 · 9 comments
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. Spec PR Tools Tooling that runs in azure-rest-api-specs repo.

Comments

@allenjzhang
Copy link
Member

allenjzhang commented Oct 31, 2023

Currently we lack of insights on the PRs for newly added product and services. I propose we add similar logic to labeller:

  1. new product. This gets added whenever new folders are created under the specification folder in PR. ie. specifications/sphere
  2. new service. This gets added whenever new folders are created:
    • directly under specifications/[product] eg specifications/sphere/Sphere.Management. This is to catch new TypeSpec specs
    • directly under specifications/[product]\data-plane. This is to catch new data-plane swaggers
    • directly under specifications/[product]\resource-manager This is to catch new ARM swaggers

With these labels and in conjunction with TypeSpec, we can easily spot TypeSpec adoption violations for the reviewer and BI later.

@github-actions github-actions bot added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Oct 31, 2023
@allenjzhang
Copy link
Member Author

@mikekistler FYI.

@konrad-jamrozik
Copy link
Contributor

Note from Allen: double check with Mike H as he is implementing similar gate checks.

@konrad-jamrozik konrad-jamrozik added Central-EngSys This issue is owned by the Engineering System team. Spec PR Tools Tooling that runs in azure-rest-api-specs repo. and removed needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Oct 31, 2023
@konrad-jamrozik
Copy link
Contributor

konrad-jamrozik commented Oct 31, 2023

This issue possibly would be a good candidate to be done at the same time as:

@maririos
Copy link
Member

@ladonnaq to look into this mapping and the one from Service Tree + Release Planner data

@maririos
Copy link
Member

With these labels and in conjunction with TypeSpec, we can easily spot TypeSpec adoption violations for the reviewer and BI later.

@konrad-jamrozik do we have any labeling automation to identify when a PR is TypeSpec vs Swagger?
Or how do we correlate the new labels with the type of PR?

@konrad-jamrozik
Copy link
Contributor

konrad-jamrozik commented Nov 2, 2023

@maririos

@konrad-jamrozik do we have any labeling automation to identify when a PR is TypeSpec vs Swagger? Or how do we correlate the new labels with the type of PR?

We do not. But I see @ckairen has implemented Get-TypeSpec-Folders.ps1 and there is some work to make it more accurate:

Also openapi-alps appears to have some logic for finding TypeSpec, e.g. typespecValidations.ts / getChangedTypeSpecPackages

Perhaps we could leverage some of the logic I listed.

@konrad-jamrozik
Copy link
Contributor

konrad-jamrozik commented Nov 2, 2023

@allenjzhang I had a chat with @weshaggard and before starting any implementation work on this issue we would first like to explore a design alternative that decouples the ask in this issue from our spec PR automation infrastructure. Looks like this work could be accomplished with a standalone PowerShell script that leverages the git repo contents and history to determine where and when TypeSpec specs have been added. No need to couple it with our existing automation.

@konrad-jamrozik konrad-jamrozik changed the title [PR Workflow] Use more labels for new spec identification [PR Workflow] Use more labels for new TypeSpec identification Nov 2, 2023
@konrad-jamrozik
Copy link
Contributor

@konrad-jamrozik
Copy link
Contributor

Filed relevant issue that does a subsets of items required by this work item:

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. Spec PR Tools Tooling that runs in azure-rest-api-specs repo.
Projects
Status: 📋 Backlog
Status: 📋 Backlog
Development

No branches or pull requests

4 participants