Skip to content

Commit 15c31d0

Browse files
Update README.md
1 parent 2eed15f commit 15c31d0

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

generator/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,12 @@ View the Pipeline Configuration [here](/azure-pipelines-autogen.yml).
3131
2. Create a Pull Request from [`autogenerate`](https://github.com/Azure/azure-resource-manager-schemas/tree/autogenerate) to [`master`](https://github.com/Azure/azure-resource-manager-schemas/tree/master).
3232
3. If there are any modifications to [schemas/common/autogeneratedResources.json](/schemas/common/autogeneratedResources.json), push a commit to the autogenerate branch to make any corresponding changes to [schemas/2014-04-01-preview/deploymentTemplate.json](/schemas/2014-04-01-preview/deploymentTemplate.json) and [schemas/2015-01-01/deploymentTemplate.json](/schemas/2015-01-01/deploymentTemplate.json).
3333

34-
#### Onboarding teams to autogeneration pipeline
35-
36-
1. Run `npm run list-basepaths` to discover the specs repo path containing the swagger definitions.
37-
1. Run `npm run generate-single {basePath}` to generate schemas for them. Save the console output to file.
38-
1. Remove all references to the provider namespace from [schemas/2019-04-01/deploymentTemplate.json](/schemas/2019-04-01/deploymentTemplate.json).
39-
1. Add the {basePath} to the autogenlist array in [autogenlist.ts](./autogenlist.ts).
40-
1. Commit all the changed files, and submit a PR to this repo with title "Onboarding {provider} for autogeneration". Include the full output saved in step 2 as a comment.
41-
1. Ensure all CI tests pass, and ask the team to review the PR (including tool output) to ensure that all expected resources have been detected and generated as expected.
34+
#### Onboarding to the autogeneration pipeline
35+
36+
1. Follow the steps listed under [Getting Started](#getting-started). The following commands assume you are running in the `generator` directory.
37+
3. Run `npm run list-basepaths` to discover the specs repo path containing the swagger definitions.
38+
4. Run `npm run generate-single {basePath}` to generate schemas for them. Save the console output to file.
39+
5. Manually remove any existing references to your provider namespace (if any) from [schemas/2019-04-01/deploymentTemplate.json](/schemas/2019-04-01/deploymentTemplate.json).
40+
6. Add the {basePath} to the autogenlist array in [autogenlist.ts](./autogenlist.ts).
41+
7. Commit all the changed files, and submit a PR to this repo with title "Onboarding {provider} for autogeneration". Include the full output saved in step 2 as a comment.
42+
8. Ensure all CI tests pass, and ask the team to review the PR (including tool output) to ensure that all expected resources have been detected and generated as expected.

0 commit comments

Comments
 (0)