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

Verify api file path and enable api-extractor for abort-controller #13861

Merged

Conversation

praveenkuttappan
Copy link
Member

Enable API extractor for abort controller and also check API extract file path

@ghost ghost added the Azure.Core label Feb 19, 2021
@praveenkuttappan praveenkuttappan added the Central-EngSys This issue is owned by the Engineering System team. label Feb 19, 2021
{
Write-Host "$($packageDir) should contain only one api review for $($packageName)"
Write-Host "No of Packages $($files.Count)"
Write-Host "$($pkgName) does not have api review json"
Copy link
Member

Choose a reason for hiding this comment

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

What if anything should folks do if they hit this issue?

Copy link
Contributor

Choose a reason for hiding this comment

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

Log an issue to get the api review file in.

We have #13387 that should fix this up across the repo. cc @KarishmaGhiya
We have the code generator now using the api extractor, so any newly generated package should have this.
Anybody using our template project as a reference should also get it

Copy link
Member

Choose a reason for hiding this comment

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

I mainly asked the question here as I think we need to improve the message here to let folks know what they should do if they hit this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Agreed. How about

THIS IS BAD! LOG A GITHUB ISSUE FOR THIS NOW!!!!

:)

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated log message

Copy link
Member Author

Choose a reason for hiding this comment

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

In addition to this change, I will check if we can update client type for util package to different type after March release. I will create and issue for tracking.There is an alternate thread on this discussion.

@KarishmaGhiya
Copy link
Member

KarishmaGhiya commented Feb 22, 2021

@praveenkuttappan You will have to commit the api review file generated with this PR and the build will pass. Run "rushx build" for this package on your local and commit the api file.

Copy link
Member

@xirzec xirzec left a comment

Choose a reason for hiding this comment

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

Cool pipeline feature!

onabort?: (ev?: Event) => any;
dispatchEvent(_event: Event): boolean;
static get none(): AbortSignal;
onabort: ((ev?: Event) => any) | null;
Copy link
Member

Choose a reason for hiding this comment

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

the only minor eyebrow raise here is the switch from onabort being optional to requiring null.

Looks like @daviwil did this 2 years ago though, so probably it's fine?

@praveenkuttappan praveenkuttappan merged commit f3661fc into Azure:master Feb 27, 2021
@praveenkuttappan praveenkuttappan deleted the set_apiextract_docmodel branch February 27, 2021 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Azure.Core Central-EngSys This issue is owned by the Engineering System team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants