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

[Recorder] Adding a note in the readme to release publicly and rename the package(everywhere) #17127

Merged
merged 4 commits into from
Aug 26, 2021

Conversation

HarshaNalluru
Copy link
Member

@HarshaNalluru HarshaNalluru commented Aug 25, 2021

Background

test-utils-recorder package 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-recorder package 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.

@@ -1,5 +1,7 @@
## Azure test-utils-recorder SDK client library for JavaScript
Copy link
Member Author

Choose a reason for hiding this comment

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

@bterlson suggests releasing under @azure-tools scope.

Copy link
Member

Choose a reason for hiding this comment

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

Yes please!

Copy link
Contributor

Choose a reason for hiding this comment

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

azure-tools or azure-sdk-tools?

Copy link
Member Author

@HarshaNalluru HarshaNalluru Aug 25, 2021

Choose a reason for hiding this comment

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

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?

Copy link
Member

@qiaozha qiaozha Aug 26, 2021

Choose a reason for hiding this comment

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

I wonder if LLC package can also make use of this test recorder libraries ?

Copy link
Member

Choose a reason for hiding this comment

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

If yes, would it be more appropriate to use @azure-tools scope ?

Copy link
Member Author

Choose a reason for hiding this comment

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

@qiaozha

@bterlson also prefers @azure-tools since we have things like autorest in that scope

Copy link
Member Author

Choose a reason for hiding this comment

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

Now, I'm inclined to @azure-tools/test-recorder

Copy link
Member Author

@HarshaNalluru HarshaNalluru Aug 26, 2021

Choose a reason for hiding this comment

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

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. 😁

@HarshaNalluru HarshaNalluru marked this pull request as draft August 26, 2021 01:58
@HarshaNalluru
Copy link
Member Author

Just waiting for a couple hundred checks in the CI. :)

Copy link
Member

@jeremymeng jeremymeng left a comment

Choose a reason for hiding this comment

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

@azure-tools/test-recorder sounds good to me. Just one comment.

sdk/test-utils/recorder-new/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder-new/README.md Outdated Show resolved Hide resolved
@HarshaNalluru HarshaNalluru changed the title [Recorder] Adding a note in the readme to release publicly [Recorder] Adding a note in the readme to release publicly and rename the package(everywhere) Aug 26, 2021
@HarshaNalluru HarshaNalluru enabled auto-merge (squash) August 26, 2021 18:57
@praveenkuttappan
Copy link
Member

/check-enforcer override

@HarshaNalluru
Copy link
Member Author

Talked to @praveenkuttappan about releasing the package.

openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this pull request Jan 6, 2022
Web ant95 2021 03 01 (Azure#16506)

* Adds base for updating Microsoft.Web from version stable/2021-02-01 to version 2021-03-01

* Updates readme

* Updates API version in new specs and examples

* Re-add Microsoft.CertificateRegistration and Microsoft.DomainRegistration APIs since they do not get pulled in by OpenApiHub (Azure#15917)

* Introduce enterpriseGradeCdnStatus to StaticSites.json (Azure#16080)

* Update StaticSites.json

* Update StaticSites.json

* Onedeploy API swapper spec (Azure#15985)

* Onedeploy API swapper spec

* Adding onedeploy custom keyword

* Formatting onedeploy api indentation

Formatting onedeploy api indentation

* prettifier

Co-authored-by: Calvin Chan <[email protected]>

* Fix status codes for syncfunctiontriggers (Azure#16413)

* Add GET endpoint at /config/authsettingsv2 for Microsoft.Web (Azure#16427)

* Add GET endpoint at /config/authsettingsv2 for Microsoft.Web

* Fix duplicate operation ids

* Swagger for ASD Transfer out (Azure#16000)

* Add domain transfer out to swagger

* Prettifier

* Add 202 response for webapp restart

* Add certificate listHostnameBindingsOfCertificate

* Formatting

* Swagger for listHostnameBindings endpoint (Azure#16516)

* Swagger for listHostnameBindings endpoint

* Re-add Microsoft.CertificateRegistration and Microsoft.DomainRegistration APIs since they do not get pulled in by OpenApiHub (Azure#15917)

* ops

Co-authored-by: Naveed Aziz <[email protected]>

* User/jennylaw/containerapp (Azure#16657)

* Pre-Prettier-commit

* Adding missing file

* Prettier fixes

* Add missing definitions

* Fix intendation in readme.md

* add suppressions

* Add custom hostname sites endpoint (Azure#16745)

* Add custom hostname sites endpoint

* Fix models

* Swagger Fixes for Container App, KubeEnvironments spec (Azure#16793)

* Pre-Prettier-commit

* Adding missing file

* Prettier fixes

* Add missing definitions

* Fix intendation in readme.md

* add suppressions

* Fix Kube Environments 2021-03-01 contract + add list secrets api to Container Apps Swagger

* Fix sercret read property

* Prettier fix

* Model fix

* Prettier Fix #2

Co-authored-by: Jenny Lawrance <[email protected]>

* Add long running extension for restart (Azure#16791)

* Remove unused API from ANT95 swagger (Azure#16901)

* Address PR comments (Azure#17019)

* Fixing PR comments (Azure#17127)

* Remove Certificate Hostname bindings API (Azure#17204)

* Remove Certificate Hostname bindings API

* Remove examples file as well

Co-authored-by: mkarmark <[email protected]>
Co-authored-by: SatishRanjan <[email protected]>
Co-authored-by: Calvin Chan <[email protected]>
Co-authored-by: Connor McMahon <[email protected]>
Co-authored-by: JennyLawrance <[email protected]>
Co-authored-by: Sanchit Mehta <[email protected]>
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.

8 participants