[Recorder] Adding a note in the readme to release publicly and rename the package(everywhere) #17127
Conversation
sdk/test-utils/recorder/README.md
Outdated
| @@ -1,5 +1,7 @@ | |||
| ## Azure test-utils-recorder SDK client library for JavaScript | |||
There was a problem hiding this comment.
@bterlson suggests releasing under @azure-tools scope.
There was a problem hiding this comment.
azure-tools or azure-sdk-tools?
There was a problem hiding this comment.
Sounds good as well, azure-sdk-tools seems more relevant to us. :)
@azure/test-utils-recorder changes to one of the following
@azure-tools/test-utils-recorder@azure-sdk-tools/test-utils-recorder(too long)@azure-tools/recorder@azure-sdk-tools/recorder(this?)
Picking @azure-sdk-tools/test-recorder as @ramya-rao-a suggesed, any objections or any other suggestions?
There was a problem hiding this comment.
I wonder if LLC package can also make use of this test recorder libraries ?
There was a problem hiding this comment.
If yes, would it be more appropriate to use @Azure-Tools scope ?
There was a problem hiding this comment.
Now, I'm inclined to @azure-tools/test-recorder
There was a problem hiding this comment.
I wonder if LLC package can also make use of this test recorder libraries ?
Currently, it supports only the SDKs in this repository because we rely on the file structure of this repo to be able to generate and pick up the recordings. We can support external packages but would need extra work to allow passing file paths as such at the very least. Any example you have in mind, @qiaozha?
I just realized.. is LLC the low level client? If they follow the same structure as other packages in this repo, we can use it. 😁
|
Just waiting for a couple hundred checks in the CI. :) |
|
/check-enforcer override |
|
Talked to @praveenkuttappan about releasing the package. |
Background
test-utils-recorderpackage is a devDependency of our packages and is maintained by the rush infra, is not published to the npm.Problem
@qiaozha has been working on getting the test framework set up for the generated SDKs in the generator repo, PR at Azure/autorest.typescript#1162.
This depends on the test-utils-recorder project. The CI fails because the test-utils-recorder library is not published to npm.
As there didn't seem to be any simpler solutions to address the problem, we are considering publishing the
@azure/test-utils-recorderpackage to npm as suggested by @sarangan12.This is the PR that adds a note in the readme stating it is not meant for public utilization.
(We may have to do the same for other utility packages if they need to be published in the future for the same reason.)
As part of publishing, we are renaming this to
@azure-tools/test-recorder.