From 06f62f748301183ece0ada15cefda4968974f368 Mon Sep 17 00:00:00 2001 From: itowlson Date: Mon, 10 Dec 2018 22:22:54 -0800 Subject: [PATCH] Prepare for initial preview release (#15) --- README.md | 24 +++++++++++++++++++++++- package.json | 14 +++++++++++++- src/extension.ts | 3 --- 3 files changed, 36 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9242db1..5364026 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ # duffle-coat -VS Code extension for generating CNAB self-installers + +A Visual Studio Code extension for generating CNAB self-installers. + +This extension adds a `Generate Self-Installer` command to the following items: + +* `bundle.json` or `bundle.cnab` files +* Bundles in the [Duffle extension's](https://marketplace.visualstudio.com/items?itemName=ms-kubernetes-tools.duffle-vscode) Bundles explorer + +The command generates an Electron application, which you can then run using `npm run dev` or package for distribution using `npm run package`. Your bundle is embedded in the application. If you choose the **Full bundle** option during generation, then all Docker images are also embedded in the application, allowing it to run entirely offline. + +Note that once generated, the Electron app code is entirely decoupled from your source bundle. If you make changes to the bundle, you'll need to regenerate the Electron app (you can choose just to update the bundle rather than overwriting the entire app). + +## Known issues + +The **Full bundle** generation options currently requires you to _push_ all depended-on Docker images to a network repository before running it. (It is not sufficient for them to be present only in the local regsitry.) This is a known issue with the `docker export` command. + +## Unknown issues + +I'm sure there are lots - please [report any you find](https://github.com/deislabs/duffle-coat/issues)! + +## Application template + +The application template lives in the `deislabs/duffle-bag` repo. You are welcome to clone this and use it as the basis for an installer application without using this extension. This extension just aims to make the job easier! diff --git a/package.json b/package.json index 3dba2d1..98fc483 100644 --- a/package.json +++ b/package.json @@ -3,6 +3,7 @@ "displayName": "Duffle Coat", "description": "Generates CNAB self-installers", "version": "0.0.1", + "preview": true, "publisher": "ms-kubernetes-tools", "engines": { "vscode": "^1.27.0" @@ -10,6 +11,10 @@ "categories": [ "Other" ], + "keywords": [ + "cnab", + "duffle" + ], "activationEvents": [ "onCommand:dufflecoat.generate" ], @@ -80,5 +85,12 @@ "tslint": "^5.8.0", "@types/node": "^8.10.25", "@types/mocha": "^2.2.42" + }, + "extensionDependencies": [ + "ms-kubernetes-tools.duffle-vscode" + ], + "repository": { + "type": "git", + "url": "https://github.com/deislabs/duffle-coat" } -} +} \ No newline at end of file diff --git a/src/extension.ts b/src/extension.ts index b7979f5..e6d3f7b 100644 --- a/src/extension.ts +++ b/src/extension.ts @@ -15,9 +15,6 @@ import * as shell from './utils/shell'; import * as duffle from './duffle/duffle'; import { move } from 'fs-extra'; -// TODO: Change to the GitHub release link once public -// const DUFFLE_BAG_VERSION = 'master'; -// const DUFFLE_BAG_ZIP_LOCATION = "https://itowlsonmsbatest.blob.core.windows.net/dbag/duffle-bag-master-test-expand.zip"; const DUFFLE_BAG_VERSION = '0.0.4'; const DUFFLE_BAG_ZIP_LOCATION = `https://github.com/deislabs/duffle-bag/archive/${DUFFLE_BAG_VERSION}.zip`;