Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add core-http-compat in Search Documents #20940

Merged

Conversation

JonathanCrd
Copy link
Member

Packages impacted by this PR

@azure/search-documents

Issues associated with this PR

Describe the problem that is addressed by this PR

Search Documents has already migrated to the new Core client and Core rest pipeline libraries, however, this introduced too many breaking changes. In order to minimize the braking changes, core-http-compat was created. This PR regenerates the client with the latest version of autorest, with the core-http-compat-mode flag set to true, and no longer depending on core-http.

Checklists

  • Added impacted package name to the issue description
  • Does this PR needs any fixes in the SDK Generator?** (If so, create an Issue in the Autorest/typescript repository and link it here)
  • Added a changelog (if necessary)

@JonathanCrd JonathanCrd self-assigned this Mar 18, 2022
@ghost ghost added the Search label Mar 18, 2022
@JonathanCrd JonathanCrd changed the title Migrate search documents to core v2 compat Add core-http-compat in Search Documents Mar 18, 2022
@check-enforcer
Copy link

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:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

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:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run js - [service] - ci

@JonathanCrd
Copy link
Member Author

/azp run js - core - ci

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@JonathanCrd
Copy link
Member Author

/azp run js - search - ci

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-sdk
Copy link
Collaborator

API changes have been detected in @azure/search-documents. You can review API changes here

API changes

- export interface SearchClientOptions extends CommonClientOptions {
+ export interface SearchClientOptions extends ExtendedCommonClientOptions {
- export interface SearchIndexClientOptions extends CommonClientOptions {
+ export interface SearchIndexClientOptions extends ExtendedCommonClientOptions {
- export interface SearchIndexerClientOptions extends CommonClientOptions {
+ export interface SearchIndexerClientOptions extends ExtendedCommonClientOptions {

Copy link
Contributor

@sarangan12 sarangan12 left a comment

Choose a reason for hiding this comment

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

LGTM

@JonathanCrd JonathanCrd merged commit a344a79 into Azure:main Mar 30, 2022
@JonathanCrd JonathanCrd deleted the Migrate-Search-Documents-to-Core-V2-compat branch June 17, 2022 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants