From 065d154e98d1ccb52af576a1d7f45f2f27dae3d7 Mon Sep 17 00:00:00 2001 From: Lajos Date: Wed, 5 May 2021 16:17:07 +0200 Subject: [PATCH] deploy, development md --- .vscodeignore | 4 +++- DEPLOY.md | 12 ++++++++++++ DEVELOPMENT.md | 16 ++++++++++++++++ 3 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 DEPLOY.md create mode 100644 DEVELOPMENT.md diff --git a/.vscodeignore b/.vscodeignore index 1ea023e..cc81af0 100644 --- a/.vscodeignore +++ b/.vscodeignore @@ -10,4 +10,6 @@ vsc-extension-quickstart.md **/*.map **/*.ts node_modules/** -.github/** \ No newline at end of file +.github/** +DEPLOY.md +DEVELOPMENT.md \ No newline at end of file diff --git a/DEPLOY.md b/DEPLOY.md new file mode 100644 index 0000000..a50ba05 --- /dev/null +++ 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. \ No newline at end of file diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..79e7727 --- /dev/null +++ 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. \ No newline at end of file