Skip to content

Commit 1b08562

Browse files
authored
remove unused script and update the doc (Azure#47373)
* remove unused script and update the doc * remove unused configuration and script * update the comment
1 parent a0c7d4f commit 1b08562

File tree

6 files changed

+11
-181
lines changed

6 files changed

+11
-181
lines changed

doc/DataPlaneCodeGeneration/Autorest_DataPlane_Quickstart.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,16 +62,16 @@ sdk\<service name>\<package name>\CHANGELOG.md
6262

6363
We will use dotnet project template [Azure.Template](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template/Azure.Template) to automatically create the project.
6464

65-
You can run `eng\scripts\automation\Invoke-DataPlaneGenerateSDKPackage.ps1` to generate the starting SDK client library package directly as following:
65+
You can run `eng\scripts\automation\Invoke-AutorestDataPlaneGenerateSDKPackage.ps1` to generate the starting SDK client library package directly as following:
6666

6767
```powershell
68-
eng/scripts/automation/Invoke-DataPlaneGenerateSDKPackage.ps1 -service <servicename> -namespace Azure.<group>.<service> -sdkPath <sdkrepoRootPath> [-inputfiles <inputfilelink>] [-readme <readmeFilelink>] [-securityScope <securityScope>] [-securityHeaderName <securityHeaderName>]
68+
eng/scripts/automation/Invoke-AutorestDataPlaneGenerateSDKPackage.ps1 -service <servicename> -namespace Azure.<group>.<service> -sdkPath <sdkrepoRootPath> [-inputfiles <inputfilelink>] [-readme <readmeFilelink>] [-securityScope <securityScope>] [-securityHeaderName <securityHeaderName>]
6969
```
7070

7171
e.g.
7272

7373
```powershell
74-
pwsh /home/azure-sdk-for-net/eng/scripts/automation/Invoke-DataPlaneGenerateSDKPackage.ps1 -service webpubsub -namespace Azure.Messaging.WebPubSub -sdkPath /home/azure-sdk-for-net -inputfiles https://github.com/Azure/azure-rest-api-specs/blob/73a0fa453a93bdbe8885f87b9e4e9fef4f0452d0/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/webpubsub.json -securityScope https://sample/.default
74+
pwsh /home/azure-sdk-for-net/eng/scripts/automation/Invoke-AutorestDataPlaneGenerateSDKPackage.ps1 -service webpubsub -namespace Azure.Messaging.WebPubSub -sdkPath /home/azure-sdk-for-net -inputfiles https://github.com/Azure/azure-rest-api-specs/blob/73a0fa453a93bdbe8885f87b9e4e9fef4f0452d0/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/webpubsub.json -securityScope https://sample/.default
7575
```
7676

7777
**Note**:
@@ -85,7 +85,7 @@ pwsh /home/azure-sdk-for-net/eng/scripts/automation/Invoke-DataPlaneGenerateSDKP
8585
- `-securityScope` designates the authentication scope to use if your library supports **Token Credential** authentication.
8686
- `-securityHeaderName` designates the key to use if your library supports **Azure Key Credential** authentication.
8787

88-
When you run the `eng\scripts\automation\Invoke-DataPlaneGenerateSDKPackage.ps1` script, it will:
88+
When you run the `eng\scripts\automation\Invoke-AutorestDataPlaneGenerateSDKPackage.ps1` script, it will:
8989

9090
- Create a project folder, install template files from `sdk/template/Azure.Template`, and create `.csproj` and `.sln` files for your new library.
9191

doc/DataPlaneCodeGeneration/AzureSDKPackage_Setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,16 @@ sdk\<service name>\<package name>\<package name>.sln
1717
- `<package name>` - Should be the name of the shipping package, or an abbreviation that distinguishes the given shipping artifact for the given service. It will be `Azure.<group>.<service>`, e.g. Azure.IoT.DeviceUpdate
1818

1919
## Create sdk package
20-
21-
We will use the Azure SDK template [Azure.Template](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template/Azure.Template) to create the initial project skeleton.
20+
21+
We will use the Azure SDK template [Azure.Template](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template/Azure.Template) to create the initial project skeleton for SDKs generated from TypeSpec.
2222

2323
You can run `eng\scripts\automation\Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1` to generate the starting SDK client library package directly as following:
2424

2525
```powershell
2626
eng/scripts/automation/Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1 -sdkFolder <sdk-folder-path> -typespecSpecDirectory <relativeTypeSpecProjectFolderPath> -commit <commitId> [-repo <specRepo>] [-additionalSubDirectories <relativeFolders>]
2727
```
2828

29-
e.g.
29+
e.g.
3030
Use git url
3131

3232
```powershell

eng/codegen_to_sdk_config.json

Lines changed: 0 additions & 31 deletions
This file was deleted.

eng/scripts/automation/Invoke-DataPlaneGenerateSDKPackage.ps1 renamed to eng/scripts/automation/Invoke-AutorestDataPlaneGenerateSDKPackage.ps1

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#Requires -Version 7.0
22
<#
33
.SYNOPSIS
4-
script for creating a getting started project in a branch of `azure-sdk-for-net` repo.
4+
script for creating a getting started project in a branch of `azure-sdk-for-net` repo for SDKs generated from swagger.
55
66
.PARAMETER service
77
The Azure client service directory name. ie. purview. It equals to the name of the directory in the specification folder of the azure-rest-api-specs repo that contains the REST API definition file.
@@ -13,7 +13,7 @@ The SDK package namespace. This value will also provide the name for the shipped
1313
The address of the root directory of sdk repo. e.g. /home/azure-sdk-for-net
1414
1515
.PARAMETER inputfiles
16-
The address of the Open API spec files, separated by semicolon if there is more than one file.
16+
The address of the Open API spec files, separated by semicolon if there is more than one file.
1717
The Open API spec file can be local file, or the web address of the file in the `azure-rest-api-specs` repo.
1818
When pointing to a local file, make sure to use **absolute path**, i.e. /home/swagger/compute.json.
1919
When pointing to a file in the `azure-rest-api-specs` repo, make sure to include the commit id in the URI, i.e. `https://github.com/Azure/azure-rest-api-specs/blob/73a0fa453a93bdbe8885f87b9e4e9fef4f0452d0/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/webpubsub.json`. This ensures that you can choose the time to upgrade to new swagger file versions.
@@ -31,10 +31,10 @@ The key to use if your library supports **Azure Key Credential** authentication.
3131
.EXAMPLE
3232
Run script with default parameters.
3333
34-
Invoke-DataPlaneGenerateSDKPackage.ps1 -service <servicename> -namespace Azure.<group>.<service> -sdkPath <sdkrepoRootPath> [-inputfiles <inputfilelink>] [-readme <readmeFilelink>] [-securityScope <securityScope>] [-securityHeaderName <securityHeaderName>]
34+
Invoke-AutorestDataPlaneGenerateSDKPackage.ps1 -service <servicename> -namespace Azure.<group>.<service> -sdkPath <sdkrepoRootPath> [-inputfiles <inputfilelink>] [-readme <readmeFilelink>] [-securityScope <securityScope>] [-securityHeaderName <securityHeaderName>]
3535
3636
e.g.
37-
Invoke-DataPlaneGenerateSDKPackage.ps1 -service webpubsub -namespace Azure.Messaging.WebPubSub -sdkPath /home/azure-sdk-for-net -inputfiles https://github.com/Azure/azure-rest-api-specs/blob/73a0fa453a93bdbe8885f87b9e4e9fef4f0452d0/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/webpubsub.json -securityScope https://sample/.default
37+
Invoke-AutorestDataPlaneGenerateSDKPackage.ps1 -service webpubsub -namespace Azure.Messaging.WebPubSub -sdkPath /home/azure-sdk-for-net -inputfiles https://github.com/Azure/azure-rest-api-specs/blob/73a0fa453a93bdbe8885f87b9e4e9fef4f0452d0/specification/webpubsub/data-plane/WebPubSub/stable/2021-10-01/webpubsub.json -securityScope https://sample/.default
3838
3939
#>
4040
param (

eng/scripts/automation/Invoke-GenerateAndBuild.ps1

Lines changed: 0 additions & 117 deletions
This file was deleted.

eng/scripts/automation/generate-and-build.sh

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)