Added a step to validate rest api spec location before release #38332
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
raych1
requested review from
hallipr,
weshaggard,
benbp and
JimSuplizio
as code owners
|
I believe the script checks for both TypeSpec and Swagger source. I can fix (if not already fixed) the case for TypeSpec. From a scan run by Ray (email "REST API spec location validation for Azure SDK packages") there is some "commit not from main branch" in Swagger case. Do we plan to require them do the fix before next release? |
This was referenced Jan 19, 2024
jeremymeng
pushed a commit
to Azure/azure-sdk-for-js
that referenced
this pull request
Jan 19, 2024
### 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
alzimmermsft
approved these changes
Jan 22, 2024
weidongxu-microsoft
approved these changes
Jan 25, 2024
Added comment for the step.
|
/check-enforcer override |
Netyyyy
pushed a commit
that referenced
this pull request
Feb 2, 2024
* Added a step to validate rest api spec location before release * Correct the artifactLocation parameter value * Update archetype-java-release.yml Added comment for the step. (cherry picked from commit d1dd313)
Netyyyy
added a commit
that referenced
this pull request
Feb 5, 2024
* Prepare for Spring Cloud Azure 4.15.0 release (#38590) * update version client * update version/changelog/readme * Added a step to validate rest api spec location before release (#38332) * Added a step to validate rest api spec location before release * Correct the artifactLocation parameter value * Update archetype-java-release.yml Added comment for the step. (cherry picked from commit d1dd313) * Increment versions for spring releases (#38615) * Increment package versions for spring releases * Update version_client.txt * Update pom.xml --------- Co-authored-by: Muyao Feng <92105726+Netyyyy@users.noreply.github.com> * fix --------- Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The purpose is to gate on the REST API specifications used to release SDK are from the main branch of Azure/azure-rest-api-specs repository.
Added a step for the validation to the release pipeline.
The common script and pipeline are merged by another PR.
Azure/azure-sdk-tools#7451
FYI - The same change has been added to dotnet release pipeline.
Azure/azure-sdk-for-net#40783