Setup local workspace

Starting with version 0.14.0, you can link a workspace to a tracked workspace directly when initializing with ipm init:

ipm init --associations 4baf8889sdfsdf --local-name "My Project"

This creates the ipmhub.json with the associations and workspaceName fields already configured — no manual editing needed.

Manual setup

If you already have an initialized workspace, you can link it to a tracked workspace by manually editing ipmhub.json:

  1. Open ipmhub.json in the workspace you want to track, create an array called associations, and add the Association ID created earlier.

        {
    "workingFolder": "packages",
    "workspaceName": "Demo1",
    "associations": [
        "4baf8889sdfsdf"
    ],
    "packages": [

    ]
    }

  2. Save the file. All future actions on this workspace will be tracked now.

Sync Workspace changes

To sync the workspace configuration, simply run ipm sync. For more information about syncing, check our page IPM Sync. After syncing, if a change was detected, a revision will be made in the Tracked Workspace. When adding a package using ipm add, this will create a new revision as well.

Example

In this example, we will add a few packages and make some changes.

  1. We will add the package: “bas-berkhout/hello-world”

  2. We update the ipmhub.json as follows: 

    {
  "workingFolder": "packages",
  "workspaceName": "This is the local name",
  "associations": [
    "4baf8889sdfsdf"
  ],
  "packages": [
    {
      "name": "bas-berkhout/hello-world",
      "version": "0.1.3"
    },
    {
      "name": "layer8solutions/azq-application-gateway",
      "version": "0.0.6"
    },
    {
      "name": "layer8solutions/azq-web-app",
      "version": "0.0.6"
    },
    {
      "name": "layer8solutions/azq-virtual-network",
      "version": "0.0.4"
    }
  ]
}
    Which results in:

IPM sync results

Click the image to enlarge

Updating Status

When you run ipm status, you will not create a new revision, but this action is logged and will update properties like “Last seen”.

ipm status results

Click the image to enlarge

Check the History

If we go to the portal and return to the workspace created earlier, you will see that we have created two revisions (timeline entries). To go to the Tracked Workspace:

  1. Go to Organizations
  2. Select the organization
  3. Open the Tracked Workspace created earlier.

Tracked Workspace timeline results

Click the image to enlarge

Logs

When we open up revision # 2, we get a clear overview of actions that were executed on this particular revision.

Tracked Workspacerevision logs

Click the image to enlarge

Package version status

When opening a revision, the packages panel shows a status indicator for each package. A warning indicator means a newer version of that package is available on the hub. Nested dependencies are labeled nested and are scanned up to 5 levels deep.

Revision package version status

Click the image to enlarge