This repository has been archived by the owner on Jul 14, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add onboard doc * improve doc * improve doc2 * improve doc3 * improve doc4 * improve doc5 * improve doc6 * improve doc7 * improve doc8 * improve doc8
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Onboarding process for using Azure Cli Codegen (autorest.az) | ||
|
||
## Step 1. Init the process | ||
|
||
Send mail to amecodegen@microsoft.com when your swagger is ready, then we will | ||
|
||
1. Do a quick validation on your swagger and prepare initial readme files for you | ||
2. Have one person assigned for your service to follow up with your for any questions and support needed | ||
|
||
## Step 2. Generate code and give it a try | ||
|
||
1. There are 3 ways to generate code now, you can pick the one you prefer. Details can be found at [here](how-to-generate.md) | ||
2. Try the generated command to see whether it meets your need. Further customization is supported if needed. Detail can be found at [FAQ](faq.md). | ||
|
||
## Step 3. Run Test | ||
1. Test will also be generated based on the examples in swagger. Run these test and make sure all of them can pass. (Refer to [here](how-to-generate.md#through-our-pre-prepared-docker) for how to run test). Customization is also supported for test if needed. Detail can be found at [here](04-scenario-test-configuration.md) | ||
2. Add more test if the generated test is not enough. Detail can be found at [here](https://github.com/Azure/azure-cli/blob/dev/doc/authoring_tests.md) | ||
|
||
## Step 4. Onboarding to azure-cli | ||
1. Follow [azure-cli guidance](https://github.com/Azure/azure-cli/blob/dev/doc/onboarding_guide.md) to onboard to azure-cli | ||
> ** we are improving the process here with Azure CLI team now | ||
## Step Next. CLI is ready when swagger is ready | ||
Autorest.az has been integrated into swagger PR. It means you can start reviewing your CLI code/command immediately when your swagger PR is filed for your new features/changes, so your new features/changes can have Azure CLI support very soon. | ||
|
||
Hopefully, **your CLI is ready to merge/release when your swagger is ready to merge. :shipit: :+1:** | ||
|
||
Check this [10-minutes video](https://msit.microsoftstream.com/video/71cea3ff-0400-a9f4-01b4-f1ea9e9b130e) for more details | ||
> ** we are working on the process here with Azure CLI and swagger team now | ||