Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update namespaces per namespace review guidance
  • Loading branch information
anthony-c-martin committed Apr 28, 2025
commit e0921a93862786f1849e148050b399e18c0e4b25
15 changes: 5 additions & 10 deletions dev/deployments/convert/markdown.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export function writeMarkdownFiles(basePath: string, filePaths: string[], compon
writeReadme(basePath, 'readme.md', getMainReadme(clientName, componentName, filePaths, latestApiVersion, suppressions[componentName]).trimStart());
writeReadme(basePath, 'readme.csharp.md', getCsharpReadme(componentName).trimStart());
writeReadme(basePath, 'readme.go.md', getGoReadme(componentName).trimStart());
writeReadme(basePath, 'readme.java.md', getJavaReadme(componentName, latestApiVersion).trimStart());
writeReadme(basePath, 'readme.java.md', getJavaReadme(componentName).trimStart());
writeReadme(basePath, 'readme.python.md', getPythonReadme(componentName).trimStart());
writeReadme(basePath, 'readme.typescript.md', getTypescriptReadme(clientName, componentName).trimStart());
}
Expand Down Expand Up @@ -249,8 +249,8 @@ csharp:
payload-flattening-threshold: 1
clear-output-folder: true
client-side-validation: false
namespace: Microsoft.Azure.Management.Deployments.${componentName}
output-folder: $(csharp-sdks-folder)/deployments/Microsoft.Azure.Management.Deployments/src/Generated
namespace: Azure.ResourceManager.Deployments.${componentName}
output-folder: $(csharp-sdks-folder)/deployments/Azure.ResourceManager.Deployments.${componentName}/GeneratedProtocol
\`\`\`
`;
}
Expand All @@ -264,26 +264,21 @@ These settings apply only when \`--go\` is specified on the command line.

\`\`\` yaml $(go) && $(track2)
license-header: MICROSOFT_MIT_NO_VERSION
module-name: sdk/resourcemanager/deployments/${componentName.toLowerCase()}
module-name: sdk/resourcemanager/deployments/arm${componentName.toLowerCase()}
module: github.com/Azure/azure-sdk-for-go/$(module-name)
output-folder: $(go-sdk-folder)/$(module-name)
azure-arm: true
\`\`\`
`;
}

function getJavaReadme(componentName: string, latestApiVersion: string) {
function getJavaReadme(componentName: string) {
return `
## Java

These settings apply only when \`--java\` is specified on the command line.
Please also specify \`--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>\`.

### Tag: ${getPackageName(latestApiVersion)} and java

These settings apply only when \`--tag=${getPackageName(latestApiVersion)} --java\` is specified on the command line.
Please also specify \`--azure-libraries-for-java-folder=<path to the root directory of your azure-sdk-for-java clone>\`.

\`\`\` yaml $(java)
java:
azure-arm: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ csharp:
payload-flattening-threshold: 1
clear-output-folder: true
client-side-validation: false
namespace: Microsoft.Azure.Management.Deployments.Bicep
output-folder: $(csharp-sdks-folder)/deployments/Microsoft.Azure.Management.Deployments/src/Generated
namespace: Azure.ResourceManager.Deployments.Bicep
output-folder: $(csharp-sdks-folder)/deployments/Azure.ResourceManager.Deployments.Bicep/GeneratedProtocol
```
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line.

``` yaml $(go) && $(track2)
license-header: MICROSOFT_MIT_NO_VERSION
module-name: sdk/resourcemanager/deployments/bicep
module-name: sdk/resourcemanager/deployments/armbicep
module: github.com/Azure/azure-sdk-for-go/$(module-name)
output-folder: $(go-sdk-folder)/$(module-name)
azure-arm: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@
These settings apply only when `--java` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`.

### Tag: package-2023-11 and java

These settings apply only when `--tag=package-2023-11 --java` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-sdk-for-java clone>`.

``` yaml $(java)
java:
azure-arm: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ csharp:
payload-flattening-threshold: 1
clear-output-folder: true
client-side-validation: false
namespace: Microsoft.Azure.Management.Deployments.DeploymentScripts
output-folder: $(csharp-sdks-folder)/deployments/Microsoft.Azure.Management.Deployments/src/Generated
namespace: Azure.ResourceManager.Deployments.DeploymentScripts
output-folder: $(csharp-sdks-folder)/deployments/Azure.ResourceManager.Deployments.DeploymentScripts/GeneratedProtocol
```
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line.

``` yaml $(go) && $(track2)
license-header: MICROSOFT_MIT_NO_VERSION
module-name: sdk/resourcemanager/deployments/deploymentscripts
module-name: sdk/resourcemanager/deployments/armdeploymentscripts
module: github.com/Azure/azure-sdk-for-go/$(module-name)
output-folder: $(go-sdk-folder)/$(module-name)
azure-arm: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@
These settings apply only when `--java` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`.

### Tag: package-2023-08 and java

These settings apply only when `--tag=package-2023-08 --java` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-sdk-for-java clone>`.

``` yaml $(java)
java:
azure-arm: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ csharp:
payload-flattening-threshold: 1
clear-output-folder: true
client-side-validation: false
namespace: Microsoft.Azure.Management.Deployments.DeploymentStacks
output-folder: $(csharp-sdks-folder)/deployments/Microsoft.Azure.Management.Deployments/src/Generated
namespace: Azure.ResourceManager.Deployments.DeploymentStacks
output-folder: $(csharp-sdks-folder)/deployments/Azure.ResourceManager.Deployments.DeploymentStacks/GeneratedProtocol
```
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line.

``` yaml $(go) && $(track2)
license-header: MICROSOFT_MIT_NO_VERSION
module-name: sdk/resourcemanager/deployments/deploymentstacks
module-name: sdk/resourcemanager/deployments/armdeploymentstacks
module: github.com/Azure/azure-sdk-for-go/$(module-name)
output-folder: $(go-sdk-folder)/$(module-name)
azure-arm: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@
These settings apply only when `--java` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`.

### Tag: package-2024-03 and java

These settings apply only when `--tag=package-2024-03 --java` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-sdk-for-java clone>`.

``` yaml $(java)
java:
azure-arm: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ csharp:
payload-flattening-threshold: 1
clear-output-folder: true
client-side-validation: false
namespace: Microsoft.Azure.Management.Deployments.Deployments
output-folder: $(csharp-sdks-folder)/deployments/Microsoft.Azure.Management.Deployments/src/Generated
namespace: Azure.ResourceManager.Deployments.Deployments
output-folder: $(csharp-sdks-folder)/deployments/Azure.ResourceManager.Deployments.Deployments/GeneratedProtocol
```
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line.

``` yaml $(go) && $(track2)
license-header: MICROSOFT_MIT_NO_VERSION
module-name: sdk/resourcemanager/deployments/deployments
module-name: sdk/resourcemanager/deployments/armdeployments
module: github.com/Azure/azure-sdk-for-go/$(module-name)
output-folder: $(go-sdk-folder)/$(module-name)
azure-arm: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@
These settings apply only when `--java` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`.

### Tag: package-2025-04 and java

These settings apply only when `--tag=package-2025-04 --java` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-sdk-for-java clone>`.

``` yaml $(java)
java:
azure-arm: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ csharp:
payload-flattening-threshold: 1
clear-output-folder: true
client-side-validation: false
namespace: Microsoft.Azure.Management.Deployments.TemplateSpecs
output-folder: $(csharp-sdks-folder)/deployments/Microsoft.Azure.Management.Deployments/src/Generated
namespace: Azure.ResourceManager.Deployments.TemplateSpecs
output-folder: $(csharp-sdks-folder)/deployments/Azure.ResourceManager.Deployments.TemplateSpecs/GeneratedProtocol
```
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line.

``` yaml $(go) && $(track2)
license-header: MICROSOFT_MIT_NO_VERSION
module-name: sdk/resourcemanager/deployments/templatespecs
module-name: sdk/resourcemanager/deployments/armtemplatespecs
module: github.com/Azure/azure-sdk-for-go/$(module-name)
output-folder: $(go-sdk-folder)/$(module-name)
azure-arm: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@
These settings apply only when `--java` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`.

### Tag: package-2022-02 and java

These settings apply only when `--tag=package-2022-02 --java` is specified on the command line.
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-sdk-for-java clone>`.

``` yaml $(java)
java:
azure-arm: true
Expand Down
Loading