Merge pull request #141 from snyk/docs/contributing

docs: update CONTRIBUTING.md with development info

Author: michelkaporin

.github/CONTRIBUTING.md

@@ -1,5 +1,17 @@
 # Contributing
 
+## Development
+### Setup
+Run `npm run build` in the root folder. All tooling prerequisites (Node.js, TypeScript etc.) can be seen [here](https://docs.microsoft.com/en-us/azure/devops/extend/develop/add-build-task?view=azure-devops#prerequisites) and should be installed.
+
+### Test and Run
+Unit tests can be run via `npm run test:unit` command.
+
+To run the code, a GitHub PR against `develop` should be raised with the committed code to the branch PR. The PR runs deployment script with deploy to development environment. The script builds the code that's added as part of your change and installs it in Azure DevOps organization as an extension that can be added to run a pipeline.
+
+## Release
+The release process is fully-automated: all you need to do is create a PR to merge `develop` into `master` and call the PR `Merge develop into master for release`.
+
 ## Contributor Agreement
 A pull-request will only be considered for merging into the upstream codebase after you have signed our [contributor agreement](https://github.com/snyk/snyk-azure-pipelines-task/blob/master/Contributor-Agreement.md), assigning us the rights to the contributed code and granting you a license to use it in return. If you submit a pull request, you will be prompted to review and sign the agreement with one click (we use [CLA assistant](https://cla-assistant.io/)).
 

ops/deploy/install-extension-to-dev-org.ts

@@ -32,24 +32,22 @@ async function main() {
       publisherName,
       extensionName,
     );
-    const alreadyInstalledVersion = alreadyInstalledExtensionInfo.version;
-    console.log(
-      `Extension version currently installed: ${alreadyInstalledVersion}`,
-    );
 
-    console.log(`Uninstalling previously installed extension`);
-    await uninstallExtension(webApi, publisherName, extensionName);
+    if (alreadyInstalledExtensionInfo) {
+      const alreadyInstalledVersion = alreadyInstalledExtensionInfo.version;
+      console.log(
+        `Extension version currently installed: ${alreadyInstalledVersion}`,
+      );
+
+      console.log(`Uninstalling previously installed extension`);
+      await uninstallExtension(webApi, publisherName, extensionName);
+    }
 
     console.log(
       'Attempting to install latest version of extension into org...',
     );
     // installExtension will throw an error if it is already installed
-    const installRes = await installExtension(
-      webApi,
-      publisherName,
-      extensionName,
-      version,
-    );
+    await installExtension(webApi, publisherName, extensionName, version);
 
     const afterInstallExtensionInfo = await getInstalledExtensionInfo(
       webApi,

package.json

@@ -48,7 +48,7 @@
   "author": "snyk.io",
   "license": "Apache-2.0",
   "dependencies": {
-    "azure-pipelines-task-lib": "2.9.3",
+    "azure-pipelines-task-lib": "3.1.0",
     "jquery": "^3.4.1",
     "vss-web-extension-sdk": "^5.141.0"
   },

vss-extension-dev.json

@@ -3,7 +3,7 @@
   "id": "snyk-security-scan-dev",
   "name": "Snyk Security Scan (Dev)",
   "version": "0.2.2",
-  "publisher": "agranado-snyk-pub",
+  "publisher": "snyk-dev",
   "targets": [
     {
       "id": "Microsoft.VisualStudio.Services"