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

Generated packages should use the latest version of @microsoft/api-extractor #1204

Closed
maorleger opened this issue Sep 29, 2021 · 6 comments · Fixed by #1207
Closed

Generated packages should use the latest version of @microsoft/api-extractor #1204

maorleger opened this issue Sep 29, 2021 · 6 comments · Fixed by #1207
Assignees

Comments

@maorleger
Copy link
Member

maorleger commented Sep 29, 2021

Please update the code gen for package.json to pull in the latest version of @microsoft/api-extractor (currently ^7.18.11).

This PR is handling updating existing packages.

Suggestion: consider reading and parsing the dependencies / devDependencies sections in https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/template/template/package.json - an intersection of those entries with what is being generated can provide better syncing between the two repos. What do you think?

Might not work for all dependencies (for example core-http vs coreV2) but we can have a allowlist of dependencies that should pull their version from the template project

@ramya-rao-a
Copy link
Contributor

Hey @JonathanCrd

Can you pick this one up?
We need this to ensure that new packages that get added to the azure-sdk-for-js repo do not end up using older version of the api extractor

cc @sarangan12

@maorleger
Copy link
Member Author

Feel free to create a separate issue for my suggestion if you think it's worth exploring or ignore it if you think it's a terrible idea 😄

@ramya-rao-a
Copy link
Contributor

Let's use this issue to just update the dependency version for api extractor
#1054 tracks the generic need to keep the code generator in sync with the dependencies we use in azure-sdk-for-js. @maorleger You can add your suggestion there :)

@maorleger
Copy link
Member Author

I noticed in passing that there are a bunch of outdated dependencies assuming I'm looking at the right file

dependencies: {
...(hasLro && { "@azure/core-lro": "^2.2.0" }),
...(hasLro && { "@azure/abort-controller": "^1.0.0" }),
...(hasAsyncIterators && { "@azure/core-paging": "^1.1.1" }),
...(!useCoreV2 && { "@azure/core-http": "^1.2.4" }),
...(useCoreV2 && { "@azure/core-client": "^1.0.0" }),
...(useCoreV2 && addCredentials && { "@azure/core-auth": "^1.3.0" }),
...(useCoreV2 && {
"@azure/core-rest-pipeline": "^1.1.0"
}),
...(tracingInfo && {
"@azure/core-tracing": "1.0.0-preview.11",
"@opentelemetry/api": "^0.10.2"
}),

Like core-tracing should be preview.13, core-http should be 2.x etc - should we update those as well in this change? I can edit the issue if so

@JonathanCrd
Copy link
Member

PR #1207 updates @microsoft/api-extractor to ^7.18.11

@ramya-rao-a should I also update the outdated dependencies that @maorleger pointed out?

@ramya-rao-a
Copy link
Contributor

@JonathanCrd Yes, please use the same PR to make the updates for the other outdated dependencies.
For reference, you can use the dependency versions in the template and text analytics packages

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 a pull request may close this issue.

3 participants