From 536ccc0f1073be26b281add63e670165ba7a7d4e Mon Sep 17 00:00:00 2001 From: Anmol Sethi Date: Wed, 26 Aug 2020 13:29:42 -0400 Subject: [PATCH] doc: Simplify build process docs (#2004) Much easier for users to use our CI scripts instead of each individual yarn step. --- doc/CONTRIBUTING.md | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md index b8b01492..a64ee8fb 100644 --- a/doc/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -60,26 +60,45 @@ reset VS Code then run `yarn vscode:patch`. ## Build +You can build with: + ```shell -yarn -yarn vscode -yarn build -yarn build:vscode -yarn release +./ci/steps/release.sh +``` + +Run your build with: + +``` cd release yarn --production # Runs the built JavaScript with Node. node . ``` -Now you can build release packages with: +Build release packages (make sure you run `./ci/steps/release.sh` first): + +``` +./ci/steps/release-packages.sh +# The standalone release is in ./release-standalone +# .deb, .rpm and the standalone archive are in ./release-packages +``` + +The `release.sh` script is the equivalent of: + +```shell +yarn +yarn vscode +yarn build +yarn build:vscode +yarn release +``` + +And `release-packages.sh` is: ``` yarn release:standalone -# The standalone release is in ./release-standalone yarn test:standalone-release yarn package -# .deb, .rpm and the standalone archive are in ./release-packages ``` ## Structure