diff --git a/README.md b/README.md index 95efc2f..f26fa7c 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,8 @@ # kapitan-vscode-extension VSCode Extension for Kapitan -### Local development: -Use the devcontainer included or a GitHub Codespace and -* Compile the `client` by running `npm --prefix client run compile`. -* Launch the python server by running from the workspace's root -```bash -python -m server --tcp -``` -Then press F5, which will open another VSCode window with the extension activated. - -The python server runs from the original window, at the terminal you used before, and all logs appear there. If you make changes to the python code, restart the python command and reload the VSCode debugging window. - -### To publish packaged extension locally: -Use the devcontainer included or a GitHub Codespace and run the following from the `./client` folder: -```bash -npm run compile -npm run webpack -npm run vscepack -``` - -To install run the following, after making sure you have uninstalled any existing installations of the extension: -```bash -code --force --install-extension PATH_TO_PACKAGES_EXTENSION.vsix -``` -Make sure to reload the VSCode window after installation. +### Developing the extension +For instructions related to developing the extension see [this README](https://github.com/kapicorp/kapitan-vscode-extension/blob/main/README_DEV.md). ### Copyright Note The typescript code is a modified copy of the `client` folder from https://github.com/QualiTorque/torque-vs-code-extensions which was licensed under Apache 2.0 License at the time the code was copied. Also, the initial folder structure, vscode setup, and CI were also heavily influenced from the same repo. \ No newline at end of file diff --git a/README_DEV.md b/README_DEV.md new file mode 100644 index 0000000..34041e0 --- /dev/null +++ b/README_DEV.md @@ -0,0 +1,23 @@ +### Building and publishing via Github Actions +The extension is built as an artifact of Github Actions on every commit to `main`. +It's published on the VSCode marketplace at every tagged commit. +The version of the extension is hardcoded on `client/package.json` and `server/server.py`. +### Local development: +Use the devcontainer included or a GitHub Codespace and +* Compile the `client` by running `npm --prefix client run compile`. +* Launch the python server by running from the workspace's root +```bash +python -m server --tcp +``` +Then press F5, which will open another VSCode window with the extension activated. + +The python server runs from the original window, at the terminal you used before, and all logs appear there. If you make changes to the python code, restart the python command and reload the VSCode debugging window. + +### To publish packaged extension locally: +Use the devcontainer included or a GitHub Codespace and run the following from the `./client` folder: +```bash +npm run compile +npm run webpack +npm run vscepack +``` +This will output an extension file (`.vsix`) which you can install by righ-clicking on it. \ No newline at end of file