a
/
code-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: Simplify build process docs (#2004) 

Much easier for users to use our CI scripts instead of each individual
yarn step.
This commit is contained in:
Anmol Sethi 2020-08-26 13:29:42 -04:00 committed by GitHub
parent 312a4d584c
commit 536ccc0f10
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/CONTRIBUTING.md
View File

@ -60,26 +60,45 @@ reset VS Code then run `yarn vscode:patch`.
## Build ## Build
You can build with:
```shell ```shell
yarn ./ci/steps/release.sh
yarn vscode ```
yarn build
yarn build:vscode Run your build with:
yarn release
```
cd release cd release
yarn --production yarn --production
# Runs the built JavaScript with Node. # Runs the built JavaScript with Node.
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 yarn release:standalone
# The standalone release is in ./release-standalone
yarn test:standalone-release yarn test:standalone-release
yarn package yarn package
# .deb, .rpm and the standalone archive are in ./release-packages
``` ```
## Structure ## Structure