Onboarding guide Onboarding Best Practices As a prerequisite please contact Carl Shipley ?rst for the PLR http aka ms plrcriteria Product Launch Readiness process Then reach out to azpycli microsoft com to get the CLI onboarding process started You'll be
Onboarding Best Practices As a prerequisite please contact Carl Shipley ?rst for the PLR http aka ms plrcriteria Product Launch Readiness process Then reach out to azpycli microsoft com to get the CLI onboarding process started You'll be assigned a dev contact on the CLI team Early and frequent communication with this contact is essential to ensuring a smooth onboarding Extension vs Module One of the key decisions you will need to make is whether to create your commands in a CLI module or an extension Extensions PROS CONS ---------------------------------------------- -------------------------------- -------------------- Release separate from the CLI release schedule Requires dedicated installation az extension add ? Higher velocity ?xes possible Can be broken by changes to the azure-cli-core Experimental UX is permissible Leverage CLI code generator to generate code CLI Modules PROS CONS ----------------------------------------------------------------------- ------- ------------------------------------------------------------------ Comes automatically with the CLI No dedicated installation required Strictly tied to CLI release schedule Unlikely to be broken by changes to azure-cli-core with test coverage STRICTLY tied to CLI authoring guidelines Experimental patterns that may be allowed in extensions could be rejected entirely for inclusion as a CLI module Common uses for extensions include experimental commands commands in private or public preview or to separate between frequently used and rarely used functionality where infrequently used commands are acquired via extension - Note that if you are trying to get commands into the CLI out of step with the normal release cycle extensions are your only option - Because non-standard experimental authoring patterns are permitted for extensions simply trying to move an extension into the CLI is often not a trivial process and will necessitate a full review with higher scrutiny from the CLI team Expect to need to make changes - If you want to use CLI code generator to generate CLI code automatically extension is your only option Please reference AZ CLI Codegen On boarding https github com Azure autorest az blob master doc -onboarding-guide md and start from Step now Initial Timeline and Milestones C- Initial Kicko ? Reach out to your contact on the CLI team Set up a short minute Teams call to discuss initial questions Initial Review Create a few commands Schedule a short minute Teams screen-share to demo your commands This is crucial Teams have created entire modules using anti-patterns resulting in comment- ?lled PRs and last-minute rework A quick command review would have prevented this During command authoring Run checks frequently to ensure you are staying on top of issues that will stall your build when you submit a PR Use commands like azdev test YOURMOD azdev style YOURMOD and azdev linter YOURMOD Periodic Command Review As practical ? ? ? ? Just before opening PR Run azdev style and azdev linter -- ci-exclusions and azdev test YOURMOD to address issues before the CI ?nds them weeks before desired release date Open PR in CLI repo public or private depending on your service Request your CLI contact as the reviewer for the PR week prior to
Documents similaires










-
34
-
0
-
0
Licence et utilisation
Gratuit pour un usage personnel Aucune attribution requise- Détails
- Publié le Jul 16, 2021
- Catégorie Philosophy / Philo...
- Langue French
- Taille du fichier 58.4kB