Introduction

@igloosoftware/ig-deploy is an npm module that automates the deployment of Widgets and Themes.

Click here to view @igloosoftware/ig-deploy on npm

Install

After creating a local directory for your new project, run the following command inside the newly created directory:

#!/bin/sh
# This will install ig-deploy into your project directory
npm install --save @igloosoftware/ig-deploy

Managing Credentials

Next, create a file named credentials.json in the root of your project directory, with the following contents:

{
  "account": "",
  "key": "",
  "url": "https://myigloorepo.blob.core.windows.net/",
  "environment": "<friendlyName>",
  "provider": "azure"
}

You must enter the credentials of your Igloo-provided Azure repository into this JSON file for the ig-deploy tool to work. The field mappings are as so:

• account: The name of your Igloo-provided Azure instance.
• key: Access/authorization key for the instance.
• url: Exact URL of the Azure blob store.
• environment: This is a friendly name for developers to identify their credential set, i.e. sandbox, testing, or production.
• provider: azure - Do not change this value.

That’s it! You’re all setup and ready to go.

Widgets (also known as Integrations)

When you are ready to deploy your custom widget, the dist sub-directory of your project directory should look like this:

Themes

Follow this guide to create your own theme, hosted in Azure, available in your Igloo community via the Theme Library.