Skip to content

Commit 8af107b

Browse files
authored
update the doc of sdk automation pipeline (#22812)
* update the doc of sdk automation pipeline * Update GenerateInputSchema.json * Update README.md * Update README.md
1 parent 149f607 commit 8af107b

File tree

2 files changed

+23
-20
lines changed

2 files changed

+23
-20
lines changed

documentation/sdkautomation/GenerateInputSchema.json

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@
4242
"type": "string"
4343
}
4444
},
45+
"relatedCadlProjectFolder": {
46+
// Related cadl project folder that pending generation.
47+
"type": "array",
48+
"items": {
49+
"type": "string"
50+
}
51+
},
4552
"installInstructionInput": {
4653
// See #InstallInstructionScriptInput
4754
"$ref": "InstallInstructionScriptInput#"
@@ -51,13 +58,5 @@
5158
"type": "string"
5259
}
5360
},
54-
"required": [
55-
"specFolder",
56-
"headSha",
57-
"headRef",
58-
"repoHttpsUrl",
59-
"trigger",
60-
"changedFiles",
61-
"relatedReadmeMdFiles"
62-
]
61+
"required": ["specFolder", "headSha", "headRef", "repoHttpsUrl", "trigger", "changedFiles", "relatedReadmeMdFiles"]
6362
}

documentation/sdkautomation/README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,21 @@ SDK Automation is launched with matrix in azure pipeline. For each language conf
1414

1515
2. Get the PR changed file list. For each changed file, find the nearest readme.md in parent folder. Get list of related readme.md.
1616

17-
3. Filter the list of readme.md with: find the `swagger-to-sdk` section in the readme.md, and see if the specified language is configured for that readme.md. Example of `swagger-to-sdk` in SDK Automation:
18-
```
19-
```yaml $(swagger-to-sdk)
20-
swagger-to-sdk:
21-
- repo: azure-sdk-for-python
22-
- repo: azure-sdk-for-java
23-
- repo: azure-sdk-for-go
24-
- repo: azure-sdk-for-js
25-
``` <EOL>
26-
```
27-
If the configured language is not found here, generation for this readme.md will be skipped.
17+
3. Filter which sdk will be generated:
18+
19+
1. For Swagger PR, filter the list of readme.md with: find the `swagger-to-sdk` section in the readme.md, and see if the specified language is configured for that readme.md. Example of `swagger-to-sdk` in SDK Automation:
20+
```
21+
```yaml $(swagger-to-sdk)
22+
swagger-to-sdk:
23+
- repo: azure-sdk-for-python
24+
- repo: azure-sdk-for-java
25+
- repo: azure-sdk-for-go
26+
- repo: azure-sdk-for-js
27+
``` <EOL>
28+
```
29+
2. For CADL PR, filter the list of cadl-project.yaml: find the `options` config in cadl-project.yaml, and see if the specified language is configure for that cadl-location.yaml.
30+
31+
If the configured language is not found here, generation for this cadl project will be skipped.
2832
2933
4. Get `specificationRepositoryConfiguration.json` from spec repo default branch. See [SpecRepoConfig](#specrepoconfig). Get the repo and branch config in the file.
3034

0 commit comments

Comments
 (0)