Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 1.85 KB
Raw

Contributing to the Azure Cloud Development Kit (CDK)

Contributing to the Azure Cloud Development Kit (CDK)

Summary

Thanks for your interest in contributing to the AZURE CDK! ❤️

This document describes how to set up a development environment and submit your contributions. Please read it carefully and let us know if it's not up-to-date (even better, submit a PR with your corrections ;-)).

Requirements

  • NodeJS >= 12.17.0
  • Yarn
  • Lerna

Building

Clone the project repository

git clone https://github.com/Yetics/armkit.git

Download dependencies and build node.js:

cd armkit/
yarn install
yarn build

Building a sample

armkit is a typescript core that translates the JSON Azure API schema definition to typescript code.

To define which API we going to translate we use either the SCHEMA_DEFINITION_URL or packages/armkit-cli/schema-config.json to specify targets.

Here is an example:

~/armkit/packages/armkit-cli$ SCHEMA_DEFINITION_URL=https://schema.management.azure.com/schemas/2018-06-01/Microsoft.DataFactory.json armkit generate

Triggering this process we call a yarn generate script section from packages.json. So we can call yarn build && yarn generate in packages/armkit-cli resulting in a .generated folder containing the typescript libraries.

  • Go to examples/basic

  • Create the template node index.js

  • You are ready to deploy:

    ~/armkit$ az deployment group create --resource-group rg-your-resourcegroup --template-file cdk.out/helloarmkit.json

Running tests

~$ yarn test