You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 5, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: Documentation/RegeneratingCode.md
+6-4
Original file line number
Diff line number
Diff line change
@@ -11,8 +11,10 @@
11
11
- Regenertion command options
12
12
- If you want to regenerate all the services then execute `gulp codegen`
13
13
- If you want to generate for your project then execute `gulp codegen --project <your project name a.k.a the key of the mappings object>`
14
-
- If you want to use a local file then save the file locally say "D:\sdk" and make sure to have the same path as defined in the source of your porject in the mappings object. Execute `gulp codegen --spec-root "D:\sdk" --project <your-project-name>`.
14
+
- If you want to use a local file then save the file locally say "D:\sdk" and make sure to have the same path as defined in the source of your project in the mappings object. Execute `gulp codegen --spec-root "D:\sdk" --project <your-project-name>`.
15
15
- If generation is successful then you will see the generated code in the lib folder under `lib/services/<YourServiceName>`
16
-
- Make sure you have License.txt, README.md and package.json file. Take a look at [StorageManagement2](https://github.com/Azure/azure-sdk-for-node/tree/master/lib/services/storageManagement2) as an example.
17
-
-**Please make sure to have accurate examples in README.md as that is what customers will see when they search for your service package on https://npmjs.com**
18
-
- Once your PR is merged into the master branch, you can publish your package to npm by following the instructions in "step 6" over [here](https://github.com/Azure/adx-documentation-pr/blob/master/clis/azure-cli/guide.md#hydra-specs-pr----node-sdk----xplat-cli)
16
+
- Make sure you have License.txt (MIT), README.md and package.json file. Take a look at [StorageManagement2](https://github.com/Azure/azure-sdk-for-node/tree/master/lib/services/storageManagement2) as an example.
17
+
-**Please make sure to have accurate examples in README.md as that is what customers will see when they search for your client libraries on [npm](https://npmjs.com).**
18
+
- Please make sure that the version in your service's package.json is also reflected in the rollup package.json (i.e. azure-sdk-for-node/package.json)
19
+
- If you are adding a brand new client library or adding a new client to your library then please make sure that a function to create a client for your service is exported in the rollup azure file (azure-sdk-for-node/lib/azure.js). You can take a look at an exported function as an example over [here](https://github.com/Azure/azure-sdk-for-node/blob/master/lib/azure.js#L1640).
20
+
- Once your PR is merged into the master branch, you can publish your package to npm by following the instructions in "step 6" over [here](https://github.com/Azure/adx-documentation-pr/blob/master/clis/azure-cli/guide.md#swagger-specs---using-autorest----node-sdk--------azure-cli)
0 commit comments