deploy, development md

configcat · May 5, 2021 · 065d154 · 065d154
1 parent 1f86913
commit 065d154
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 1 deletion.
diff --git a/.vscodeignore b/.vscodeignore
@@ -10,4 +10,6 @@ vsc-extension-quickstart.md
 **/*.map
 **/*.ts
 node_modules/**
-.github/**
+.github/**
+DEPLOY.md
+DEVELOPMENT.md
diff --git a/DEPLOY.md b/DEPLOY.md
@@ -0,0 +1,12 @@
+# How to deploy
+
+1. Increase version
+Increase version number by using `npm version patch | minor | major`
+
+    *Example: increasing patch version* 
+    ```bash
+    npm version patch
+    ```
+1. Commit & Push
+1. Create new release
+Create new release at with the version number (vX.X.X) at https://github.com/configcat/vscode-extension-configcat/releases.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -0,0 +1,16 @@
+# Development
+## Modules
+The code is splitted into 2 parts.
+
+### Webpanel
+The webpanel is an Angular project, which can show and update Feature Flag values.
+Source: `./webpanel`
+Build it with `npm run webpanel-build`
+
+### VS Code extension
+Source: `./src`
+Build it with `npm run esbuild` or run it with hitting F5 in VSCode
+
+## Packaging
+To create a vsix package run `npm run package`. 
+This package can be installed in VSCode/Extensions/... menu/Install from VSIX package.