From f2495cfca956899d3909257452ccc4d0b3aeaaf0 Mon Sep 17 00:00:00 2001 From: Anmol Sethi <hi@nhooyr.io> Date: Wed, 26 Aug 2020 07:00:10 -0400 Subject: [PATCH 1/2] doc: Simplify build process docs Much easier for users to use our CI scripts instead of each individual yarn step. --- doc/CONTRIBUTING.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md index af04b57ccf7d..f0640899c316 100644 --- a/doc/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -49,12 +49,10 @@ reset VS Code then run `yarn vscode:patch`. ## Build +The script we run in CI that does all the above + ```shell -yarn -yarn vscode -yarn build -yarn build:vscode -yarn release +./ci/steps/release.sh cd release yarn --production # Runs the built JavaScript with Node. @@ -64,11 +62,27 @@ node . Now you can build release packages with: ``` -yarn release:standalone +./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 yarn test:standalone-release yarn package -# .deb, .rpm and the standalone archive are in ./release-packages ``` ## Structure From 8e097c48f6bdf11d1e8d5cb645e9d405efce08f1 Mon Sep 17 00:00:00 2001 From: Anmol Sethi <hi@nhooyr.io> Date: Wed, 26 Aug 2020 13:26:13 -0400 Subject: [PATCH 2/2] fixup! doc: Simplify build process docs --- doc/CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md index f0640899c316..eb914ef8c054 100644 --- a/doc/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -49,17 +49,22 @@ reset VS Code then run `yarn vscode:patch`. ## Build -The script we run in CI that does all the above +You can build with: ```shell ./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