Skip to content

Commit be67669

Browse files
Copilotjeremymeng
andauthored
Point typespec-ts generator references to Azure/typespec-azure; drop legacy autorest promotion
Co-authored-by: jeremymeng <7583839+jeremymeng@users.noreply.github.com>
1 parent 722c7b8 commit be67669

12 files changed

Lines changed: 18 additions & 20 deletions

File tree

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@
2020

2121
### Checklists
2222
- [ ] Added impacted package name to the issue description.
23-
- [ ] Does this PR need any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here.)_
23+
- [ ] Does this PR need any fixes in the SDK Generator?** _(If so, create an Issue in the [typespec-ts](https://github.com/Azure/typespec-azure) repository and link it here.)_
2424
- [ ] Added a changelog (if necessary).

.github/instructions/reviewer/mgmt-sdk.instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Breaking changes are acceptable in mgmt SDKs with proper CHANGELOG documentation
2828
**Root-cause analysis:** Trace breaking changes to their source:
2929
- API version change in spec → expected, document in changelog
3030
- TypeSpec migration artifact → may be approved pattern, check with architects
31-
- Emitter/tooling bug → report to autorest.typescript
31+
- Emitter/tooling bug → report to typespec-ts
3232
- Do NOT flag cosmetic changes: `XxxOptionalParams→XxxOptions`, response wrapper removal
3333

3434
**Changelog alignment:** Public API changes in `review/*.api.md` must be documented:
@@ -76,6 +76,6 @@ Flag patterns indicating spec problems:
7676
- Do NOT post the same comment on every file that has the same issue
7777

7878
## Issue Types
79-
**🔴 Tool Issue:** Generation bug → fix + report to [autorest.typescript](https://github.com/Azure/autorest.typescript/issues)
79+
**🔴 Tool Issue:** Generation bug → fix + report to [typespec-ts](https://github.com/Azure/typespec-azure/issues)
8080
**🔴 Design Issue:** API problem → `@clientName`/`@override` in spec repo
8181
**🔵 Suggestion:** Optional improvement

.github/prompts/mgmt-review-guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ However we should report the following cases:
8080

8181
Spec Issue Comment: Review comments on public API often request changes to the generated API surface — renaming types, renaming properties, or changing property types to be more user-friendly. These changes are made in the spec repo's `client.tsp` using TypeSpec decorators (primarily `@clientName`). For these comments, do NOT request changes to generated code; instead, suggest updating the specification repository and triggering SDK regeneration.
8282

83-
Tool Issue Comment: For issues that do not require spec changes, use the validation rules to detect tool issues. We can directly suggest changes in generated code and recommend reporting issues in the [generation tool repository](https://github.com/Azure/autorest.typescript/issues).
83+
Tool Issue Comment: For issues that do not require spec changes, use the validation rules to detect tool issues. We can directly suggest changes in generated code and recommend reporting issues in the [generation tool repository](https://github.com/Azure/typespec-azure/issues).
8484

8585
### Format
8686

@@ -107,7 +107,7 @@ If the API surface and tool validation look good, say so explicitly in one sente
107107
> 🔴 **Tool Issue**`CHANGELOG.md:42`
108108
> `Compared with 1.0.0-alpha.20260311.1:`.
109109
> We should not compare with alpha versions in `CHANGELOG.md`; this suggests a tooling bug.
110-
> **Fix:** Update the changelog to compare with the latest preview or stable version, and report the issue in the [generation tool repository](https://github.com/Azure/autorest.typescript/issues).
110+
> **Fix:** Update the changelog to compare with the latest preview or stable version, and report the issue in the [generation tool repository](https://github.com/Azure/typespec-azure/issues).
111111
112112
### Bad finding (too noisy — do NOT flag these)
113113

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@
2121

2222
### Checklists
2323
- [ ] Added impacted package name to the issue description
24-
- [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_
24+
- [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [typespec-ts](https://github.com/Azure/typespec-azure) repository and link it here)_
2525
- [ ] Added a changelog (if necessary)

.github/workflows/mgmt-review.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ line using `create-pull-request-review-comment`:
152152
> 🔴 **Tool Issue**`CHANGELOG.md:42`
153153
> `Compared with 1.0.0-alpha.20260311.1:`.
154154
> We should not compare with alpha versions in `CHANGELOG.md`; this suggests a tooling bug.
155-
> **Fix:** Update `CHANGELOG.md` to compare with the latest preview or stable version, and report the issue in the [generation tool repository](https://github.com/Azure/autorest.typescript/issues).
155+
> **Fix:** Update `CHANGELOG.md` to compare with the latest preview or stable version, and report the issue in the [generation tool repository](https://github.com/Azure/typespec-azure/issues).
156156
157157
After all inline comments, **submit the review** using
158158
`submit-pull-request-review` with:

sdk/core/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For more information, refer to https://github.com/Azure/azure-sdk-for-js/tree/ma
2424

2525
### ServiceClient
2626

27-
Client libraries come in two flavors: authored and generated. Generated clients are produced by [AutoRest](#autorest-and-generated-clients) whereas authored clients are written by hand. Typically, authored clients wrap generated clients and extend them with custom API surface.
27+
Client libraries come in two flavors: authored and generated. Generated clients are produced by a [code generator](#code-generation-and-generated-clients) whereas authored clients are written by hand. Typically, authored clients wrap generated clients and extend them with custom API surface.
2828

2929
`ServiceClient` is the base class of all generated clients. It builds on top of the HTTP Pipeline in order to make requests to services.
3030

@@ -161,11 +161,9 @@ AzureLogger.log = (...args) => {
161161
};
162162
```
163163

164-
## AutoRest and Generated Clients
164+
## Code Generation and Generated Clients
165165

166-
[AutoRest](https://github.com/Azure/autorest) is a generation tool for creating a client library using an [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) (formerly known as "Swagger".)
167-
168-
AutoRest is used in conjunction with the [autorest.typescript extension](https://github.com/Azure/autorest.typescript) to generate client libraries for JS/TS consumers. While the generated code tries as much as possible to fulfill the [TS design guidelines](https://azure.github.io/azure-sdk/typescript_introduction.html), it is often necessary to wrap the generated client classes in what are known as "convenience clients."
166+
Client libraries for JS/TS consumers are generated from [TypeSpec](https://typespec.io) specifications using the [`@azure-tools/typespec-ts`](https://github.com/Azure/typespec-azure/tree/main/packages/typespec-ts) emitter. While the generated code tries as much as possible to fulfill the [TS design guidelines](https://azure.github.io/azure-sdk/typescript_introduction.html), it is often necessary to wrap the generated client classes in what are known as "convenience clients."
169167

170168
A convenience client extends the shape of a generated client in ways that make it more approachable to the consumer, such as simplifying the return shape of methods or adding helper functions for common operations.
171169

sdk/core/core-client-rest/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Azure Rest Core client library for JavaScript
22

3-
This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest) and [`autorest.typescript`](https://github.com/Azure/autorest.typescript). Specifically for rest level clients
3+
This library is primarily intended to be used in code generated by the [TypeSpec](https://typespec.io) [`@azure-tools/typespec-ts`](https://github.com/Azure/typespec-azure/tree/main/packages/typespec-ts) emitter. Specifically for rest level clients
44

55
## Getting started
66

@@ -27,7 +27,7 @@ Examples can be found in the `samples` folder.
2727

2828
You can build and run the tests locally by executing `npm run test`. Explore the `test` folder to see advanced usage and behavior of the public classes.
2929

30-
Learn more about [AutoRest](https://github.com/Azure/autorest) and the [autorest.typescript extension](https://github.com/Azure/autorest.typescript) for generating a compatible client on top of this package.
30+
Learn more about the [TypeSpec](https://typespec.io) [`@azure-tools/typespec-ts`](https://github.com/Azure/typespec-azure/tree/main/packages/typespec-ts) emitter for generating a compatible client on top of this package.
3131

3232
## Troubleshooting
3333

sdk/core/core-client/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Azure Core Service client library for JavaScript
22

3-
This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest) and [`autorest.typescript`](https://github.com/Azure/autorest.typescript).
3+
This library is primarily intended to be used in code generated by the [TypeSpec](https://typespec.io) [`@azure-tools/typespec-ts`](https://github.com/Azure/typespec-azure/tree/main/packages/typespec-ts) emitter.
44

55
## Getting started
66

@@ -39,7 +39,7 @@ The method `createSerializer` creates a `Serializer` that is used to do the bulk
3939

4040
You can build and run the tests locally by executing `npm run test`. Explore the [test](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-client/test) folder to see advanced usage and behavior of the public classes.
4141

42-
Learn more about [AutoRest](https://github.com/Azure/autorest) and the [autorest.typescript extension](https://github.com/Azure/autorest.typescript) for generating a compatible client on top of this package.
42+
Learn more about the [TypeSpec](https://typespec.io) [`@azure-tools/typespec-ts`](https://github.com/Azure/typespec-azure/tree/main/packages/typespec-ts) emitter for generating a compatible client on top of this package.
4343

4444
## Troubleshooting
4545

sdk/core/core-lro/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Azure Core LRO client library for JavaScript
22

3-
This is the default implementation of long running operations in Azure SDK JavaScript client libraries which work in both the browser and NodeJS. This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest) and [`autorest.typescript`](https://github.com/Azure/autorest.typescript).
3+
This is the default implementation of long running operations in Azure SDK JavaScript client libraries which work in both the browser and NodeJS. This library is primarily intended to be used in code generated by the [TypeSpec](https://typespec.io) [`@azure-tools/typespec-ts`](https://github.com/Azure/typespec-azure/tree/main/packages/typespec-ts) emitter.
44

55
`@azure/core-lro` follows [The Azure SDK Design Guidelines for Long Running Operations](https://azure.github.io/azure-sdk/typescript_design.html#ts-lro)
66

sdk/core/core-rest-pipeline/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Azure Core HTTP client library for JavaScript
22

3-
This is the core HTTP pipeline for Azure SDK JavaScript libraries which work in the browser and Node.js. This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest) and [`autorest.typescript`](https://github.com/Azure/autorest.typescript).
3+
This is the core HTTP pipeline for Azure SDK JavaScript libraries which work in the browser and Node.js. This library is primarily intended to be used in code generated by the [TypeSpec](https://typespec.io) [`@azure-tools/typespec-ts`](https://github.com/Azure/typespec-azure/tree/main/packages/typespec-ts) emitter.
44

55
## Getting started
66

0 commit comments

Comments
 (0)