Skip to content

Commit

Permalink
Rename feature/v3 branch to main (#5040)
Browse files Browse the repository at this point in the history
Co-authored-by: Wes Haggard <[email protected]>
  • Loading branch information
hallipr and weshaggard authored Sep 5, 2024
1 parent 30f9e2b commit 25bb05e
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/TypeSpec.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

## TypeSpec Pipeline Overview

C# code generation TypeSpec pipeline consists of two major components: TypeSpec compiler that inputs API specification and outputs tspCodeModel.json using [TypeSpec C# Emitter](https://github.com/Azure/autorest.csharp/tree/feature/v3/src/TypeSpec.Extension/Emitter.Csharp), and autorest.csharp (a.k.a [generator](https://github.com/Azure/autorest.csharp/tree/feature/v3/src/AutoRest.CSharp)), executed in standalone mode, which inputs tspCodeModel.json and outputs C# files that contain clients and models for interaction with cloud service.
C# code generation TypeSpec pipeline consists of two major components: TypeSpec compiler that inputs API specification and outputs tspCodeModel.json using [TypeSpec C# Emitter](https://github.com/Azure/autorest.csharp/tree/main/src/TypeSpec.Extension/Emitter.Csharp), and autorest.csharp (a.k.a [generator](https://github.com/Azure/autorest.csharp/tree/main/src/AutoRest.CSharp)), executed in standalone mode, which inputs tspCodeModel.json and outputs C# files that contain clients and models for interaction with cloud service.

## TypeSpec C# Emitter
Emitter generates tspCodeModel.json from subset of TypeSpec compiler output object graph. Resulting output is a standard JSON file with circular references support. It doesn't have explicit specification. Instead, it is assumed that InputModel types defined in [TS](https://github.com/Azure/autorest.csharp/tree/feature/v3/src/TypeSpec.Extension/Emitter.Csharp/src/type) and in [C#](https://github.com/Azure/autorest.csharp/tree/feature/v3/src/AutoRest.CSharp/Common/Input) match each other. When new features in generator require InputModel types to be modified or extended, there is no backwards compatibility requirement. Hence, releases of autorest.csharp and TypeSpec C# Emitter must be synchronized so that autorest.csharp can deserialize `tspCodeModel.json` produced by emitter without errors.
Expand Down
2 changes: 1 addition & 1 deletion eng/pipelines/mgmt-mocktest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ schedules:
displayName: "4AM (UTC +8) daily mock test"
branches:
include:
- feature/v3
- main

variables:
OfficialBuildId: $(Build.BuildNumber)
Expand Down
4 changes: 2 additions & 2 deletions eng/pipelines/sync-sharedcode.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ schedules:
displayName: 'Daily Synchronize Azure Core Shared Codes'
branches:
include:
- feature/v3
- main
always: true

extends:
Expand All @@ -32,7 +32,7 @@ extends:
workingDirectory: $(Build.SourcesDirectory)/autorest.csharp
- template: /eng/common/pipelines/templates/steps/create-pull-request.yml@azure-sdk-tools
parameters:
BaseBranchName: feature/v3
BaseBranchName: main
RepoName: autorest.csharp
PROwner: Azure
PRBranchName: update-azure-core-shared-codes-$(Build.BuildId)
Expand Down
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ It packages a bunch of test swagger files, along with a “mock” nodejs server

The swagger files are compiled, and then run, which pings the mock server (to verify behavior). This tests both the Modeler 4 and language specific codegen.

This document contains some additional [technical details](https://github.com/Azure/autorest.csharp/blob/feature/v3/test/README.md).
This document contains some additional [technical details](https://github.com/Azure/autorest.csharp/blob/main/test/README.md).

**cadl-ranch**

Expand Down Expand Up @@ -141,7 +141,7 @@ When the autorest.csharp PR gets merged there will be an automatic azure-sdk-for

Run `dotnet build /t:GenerateCode` in the directory that contains your `.csproj` file.

This executes [these targets](https://github.com/Azure/autorest.csharp/blob/feature/v3/src/AutoRest.CSharp/build/CodeGeneration.targets).
This executes [these targets](https://github.com/Azure/autorest.csharp/blob/main/src/AutoRest.CSharp/build/CodeGeneration.targets).

Refer also to [azure-sdk-for-net/CONTRIBUTING.md](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md#on-boarding-new-generated-code-library) for more details.

Expand Down
2 changes: 1 addition & 1 deletion src/TypeSpec.Extension/Emitter.Csharp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"author": "Microsoft Corporation",
"description": "The typespec library that can be used to generate C# models from a TypeSpec REST protocol binding",
"homepage": "https://github.com/Microsoft/typespec",
"readme": "https://github.com/Azure/autorest.csharp/blob/feature/v3/src/TypeSpec.Extension/Emitter.Csharp/readme.md",
"readme": "https://github.com/Azure/autorest.csharp/blob/main/src/TypeSpec.Extension/Emitter.Csharp/readme.md",
"license": "MIT",
"repository": {
"type": "git",
Expand Down
2 changes: 1 addition & 1 deletion test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ As the Azure SDK has multiple supported languages, Autorest uses plugins for eac

During autorest execution, the plugin is passed a YAML intermediate representation (IR) of the API definition.

[Example YAML IR](https://github.com/Azure/autorest.csharp/blob/feature/v3/test/TestServerProjects/additionalProperties/Generated/CodeModel.yaml)
[Example YAML IR](https://github.com/Azure/autorest.csharp/blob/main/test/TestServerProjects/additionalProperties/Generated/CodeModel.yaml)

The plugin is normally called via JSON RPC but there is a standalone mode that can process the intermediate yaml from disk.

Expand Down

0 comments on commit 25bb05e

Please sign in to comment.