New validation for REST API spec location before SDK release #7451
Conversation
SDK release pipeline would run this validation to ensure the spec comes from the main branch of Azure/azure-rest-api-specs repo
raych1
requested review from
konrad-jamrozik,
weshaggard and
benbp
as code owners
|
The following pipelines have been queued for testing: |
eng/common/pipelines/templates/steps/verify-restapi-spec-location.yml
Outdated
Show resolved
Hide resolved
|
The following pipelines have been queued for testing: |
|
The following pipelines have been queued for testing: |
eng/common/pipelines/templates/steps/verify-restapi-spec-location.yml
Outdated
Show resolved
Hide resolved
|
The following pipelines have been queued for testing: |
|
The following pipelines have been queued for testing: |
|
The following pipelines have been queued for testing: |
| [ValidateNotNullOrEmpty()] | ||
| [string] $ArtifactLocation, | ||
| [Parameter(Position = 2)] | ||
| [string]$GitHubPat = $($env:GH_TOKEN), |
There was a problem hiding this comment.
Get the token from environment variable so that it won't be leaked in the pipeline log.
|
@weshaggard , can you also approve this PR if the change looks good? |
eng/common/pipelines/templates/steps/verify-restapi-spec-location.yml
Outdated
Show resolved
Hide resolved
|
The following pipelines have been queued for testing: |
Sync eng/common directory with azure-sdk-tools for PR Azure/azure-sdk-tools#7451 See [eng/common workflow](https://github.com/Azure/azure-sdk-tools/blob/main/eng/common/README.md#workflow) --------- Co-authored-by: raychen <raychen@microsoft.com>
### Purpose of this PR The purpose is to gate on the REST API specifications used to release SDK are from the main branch of [Azure/azure-rest-api-spec](https://github.com/Azure/azure-rest-api-specs). ### Packages impacted by this PR All the data plane GA packages to be released. I scanned through this JS repo and identified 11 data plane services that have released GA packages but their configuration file either `tsp-location.yaml` or `swagger\README.md` reference the REST API specs from a non-main branch of Azure spec repo. Please refer to [this spreadsheet](https://microsoftapc-my.sharepoint.com/:x:/g/personal/raychen_microsoft_com/ETMHnmWSA6VKmGouTjAITwEBqSavTLQkOcd2Ykx2eEE8_g?e=oalb1N) to get the details of all the violated packages. After this PR is merged, the next GA release for these packages will be blocked. They need to correct the spec path before releasing GA packages. ### Describe the problem that is addressed by this PR Added a pipeline from common template to release pipeline to validate the REST API specification location is from the main branch of [Azure/azure-rest-api-spec](https://github.com/Azure/azure-rest-api-specs). This validation will be skipped if the package to be released is non-GA package. ### Provide a list of related PRs The common script and pipeline were merged by another PR. Azure/azure-sdk-tools#7451 FYI - The same change has been added to other language repos' release pipelines. Azure/azure-sdk-for-net#40783 Azure/azure-sdk-for-java#38332
We only support the SDK release for the spec checked into 'main' branch of Azure/azure-rest-api-specs repository.
tsp-location.yaml(typespec case) and validation onautorest.md(swagger case)@weshaggard can you review?