Detect Api changes in PR using pipeline generated code file #25327
Conversation
|
API change check APIView has identified API level changes in this PR and created following API reviews. |
praveenkuttappan
requested review from
scbedd,
weshaggard and
benbp
as code owners
|
These changes are to test and support sandboxing for python. Once all other language parsers are ready, this will be moved to eng/common. |
eng/scripts/Detect-ApiChanges.ps1
Outdated
| @@ -0,0 +1,129 @@ | |||
| [CmdletBinding()] | |||
There was a problem hiding this comment.
minor but you renamed this file from what is currently in common. In Common this is called Detect-Api-Changes.ps1, not sure if that is intentional or not but wanted to call it out.
There was a problem hiding this comment.
It was intentional change but not really needed. I will update the name.
There was a problem hiding this comment.
Removed this file. I am changing common script
eng/scripts/Detect-ApiChanges.ps1
Outdated
| $query.Add('language', $LanguageShort) | ||
| $query.Add('codeFile', $reviewFileName) |
There was a problem hiding this comment.
Are these the only real changes to this script?
There was a problem hiding this comment.
yes. Changing this over to common script is easier for API change detect in PR request. I will change common script as soon as other language starts creating and publishing API code file artifact.
There was a problem hiding this comment.
I will actually check if I can make a change in common script itself for this use case and pass these new params conditionally.
There was a problem hiding this comment.
Removed this file. I have updated common file to pass extra parameter conditionally if APIview code file exists. This was doable since we reused existing REST API to check API changes.
|
This pull request is protected by Check Enforcer. What is Check Enforcer?Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass. Why am I getting this message?You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged. What should I do now?If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows: What if I am onboarding a new service?Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment: |
praveenkuttappan
force-pushed
the
detect_apichange_using_generated_codefile
branch
from
d99ba0c to
7b978b0
Compare
|
I will close this PR and do this change in eng/common/scripts to pass new parameter in REST API to apiview. Here is the PR for changes in eng/common. //fyi: @scbedd , @weshaggard |
|
Closing this PR since change was done in eng/common script. |
Detect API changes in PR using generated code file by CI (Part of sandboxing project to avoid running parser within APIView server)