Skip to content

PR Check Modernization

Mike Harder edited this page Jan 8, 2025 · 15 revisions

Goal

Improve reliability, performance, maintainability, portability (the ability to run locally), and "contribute-ability" of the checks run on PRs in this repo.

Expected outcomes

  1. Code for all checks moves out of repo openapi-alps, and into repo azure-rest-api-specs or azure-sdk-tools.
  2. All pipelines, jobs, etc. move out of DevDiv DevOps org and into GitHub Actions or the azure-sdk DevOps org.
  3. Reduced complexity - Examples: minimize server resources, all tests can be run locally, clear/actionable error messages everywhere

Checks

Mike Wes Daniel Ray APIView team
- TypeSpecValidation as ESLint rules (PR)
- Swagger Avocado
- Swagger LintDiff
- Swagger BreakingChanges
- Pipeline-bot
- CredScan - SDK azure-resource-manager-schemas
- TypeSpec Validation (ramp up)
- Swagger SpellCheck (ramp up)
- Swagger ApiDocPreview
- PR Summary
- SDK azure-sdk-for-* pipelines (SDK automation)
- Swagger ModelValidation (TBD)
- Swagger SemanticValidation (TBD)
- [Dozie] Swagger ApiView
- [Albert] TypeSpec ApiView

Victor's List

"For those about to simplify, we salute you!"

Date Check Gladiator
10/9/24 SDK azure-resource-manager-schemas Daniel
10/25/2024 TypeSpec Validation (perf improvements and GHA migration) Daniel
11/13/24 Armstrong Validation Mike
11/13/24 Swagger ApiView Dozie
12/11/24 TypeSpec ApiView
- Disable in openapi-alps
Albert
12/11/24 Add-label, update-labels composite actions Mike
1/8/25 SDK Suppression Labels (PR) Jack + Ray

Overview

TypeSpec

Engineering System

Meta

Under Construction

Clone this wiki locally