Skip to content

Conversation

@praveenkuttappan
Copy link
Member

Currently API detection step sends request to APIView production instance. This PR is to support alternate environment to test API change detection from test pipeline (specially to test SDK automation).

@praveenkuttappan
Copy link
Member Author

@weidongxu-microsoft This PR is required for you to integrate SDK automation from test pipeline. Once this PR is merged, you can set pipeline variable "ApiChangeDetectRequestUrl" to pass staging instance URL so SDK automation test pipeline can create review in test env. I will send you details offline.

@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@praveenkuttappan
Copy link
Member Author

@benbp @weshaggard Can you please review this change and approve? We need this PR to support staging or any test API view environment to create API review from a test pipeline. Specifically required for SDK automation demo next week. Thanks

//cc: @weidongxu-microsoft

$apiChangeDetectRequestUrl = "https://apiview.dev/PullRequest/DetectApiChanges"
echo "##vso[task.setvariable variable=ApiChangeDetectRequestUrl]$apiChangeDetectRequestUrl"
displayName: "Set API change detect request URL"
condition: eq(variables['ApiChangeDetectRequestUrl'], '')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you tried setting this as the default in a variables block in this file? It would be simpler.

variables:
  ApiChangeDetectRequestUrl: <value that gets overwritten>

Also, how should a pipeline template caller override this variable? Would it be easier to use a devops parameter and default it instead?

parameters:
  ApiChangeDetectRequestUrl: <url>

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why didn't we override existing param to support different URL from caller YAML:

Caller pipeline yaml is same in test as well as main repo since it is a copy of azure sdk language repos. Even if we modify caller pipeline then it will get overridden with changes from main branch.

pipeline doesn't have any step level variable. We will need to set this as job level variable for all languages in caller side. Devops is failing with incorrect yaml when variables is added in this block.

Caller pipeline can setup pipeline queue time variable whenever we want to test manually against different instance. This change is to support testing API change detection using non prod APIView instance for demo or for manual testing.

@benbp benbp self-requested a review March 7, 2022 21:59
@ghost
Copy link

ghost commented Mar 8, 2022

Hello @azure-sdk!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@ghost ghost merged commit f8f4f95 into Azure:main Mar 8, 2022
@weidongxu-microsoft
Copy link
Member

@dw511214992 here is the right Wei Dong :-)

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants