Use VS Code with Cloudmarque Azure

This guide walks you through setup of Visual Studio Code as development tooling used to develop Cloudmarque PowerShell Tools for Azure.

Use this guide if you are planning to fork Cloudmarque PowerShell Tools for Azure, including Automation Account Runbooks or deploy pipelines. This gives you the recommended tooling for development, and allows you to extend the framework for your own needs.

Set up a development environment

1. Install dependencies

   The following pre-requisites are required:

   1. Install Git
   2. Install PowerShell
   3. Install Azure PowerShell Modules

   Install Visual Studio Code

   Visual Studio Code (VSCode) is the recommended IDE for developing Cloudmarque.Azure. VSCode is a free IDE developed by Microsoft and the open source community. It is available online via a browser as part of Visual Studio Online, and can also be installed locally across Windows, Mac, and Linux.

   These instructions provide typical defaults for a local installation.

   1. Download and install Visual Studio Code from [https://code.visualstudio.com/]

   2. In the Extensions tab, search for and install:
      • Material Icon Theme
      • PowerShell
      • Prettify JSON
      • Azure Repos
      • Azure Account
      • Liquid
      • Sass
      • GitLens
   3. Perform any personal quality-of-life changes to customise the environment to your liking:
      • Set your favourite theme

      • Tweak settings

        NB: Users familiar with Visual Studio Pro/Enterprise may particularly want to set "workbench.sideBar.location": "right" to move the side panel (File Explorer, Source Control, Extensions, etc) to the right.

2. Clone the target repository

   git clone https://www.github.com/Trustmarque/<repo> [local dir]

We recommend forking the repository to your own source control system, treating the main public Cloudmarque repository as an upstream source:

   git remote rename origin upstream
   git remote add origin [your repo]

If you want to access an existing topic branch, use:

   git checkout [branch-name]

1. Create a development branch

   git branch topic-<Your feature name>