Skip to content

Commit 536ccc0

Browse files
authored
doc: Simplify build process docs (#2004)
Much easier for users to use our CI scripts instead of each individual yarn step.
1 parent 312a4d5 commit 536ccc0

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

doc/CONTRIBUTING.md

+26-7
Original file line numberDiff line numberDiff line change
@@ -60,26 +60,45 @@ reset VS Code then run `yarn vscode:patch`.
6060

6161
## Build
6262

63+
You can build with:
64+
65+
```shell
66+
./ci/steps/release.sh
67+
```
68+
69+
Run your build with:
70+
71+
```
72+
cd release
73+
yarn --production
74+
# Runs the built JavaScript with Node.
75+
node .
76+
```
77+
78+
Build release packages (make sure you run `./ci/steps/release.sh` first):
79+
80+
```
81+
./ci/steps/release-packages.sh
82+
# The standalone release is in ./release-standalone
83+
# .deb, .rpm and the standalone archive are in ./release-packages
84+
```
85+
86+
The `release.sh` script is the equivalent of:
87+
6388
```shell
6489
yarn
6590
yarn vscode
6691
yarn build
6792
yarn build:vscode
6893
yarn release
69-
cd release
70-
yarn --production
71-
# Runs the built JavaScript with Node.
72-
node .
7394
```
7495

75-
Now you can build release packages with:
96+
And `release-packages.sh` is:
7697

7798
```
7899
yarn release:standalone
79-
# The standalone release is in ./release-standalone
80100
yarn test:standalone-release
81101
yarn package
82-
# .deb, .rpm and the standalone archive are in ./release-packages
83102
```
84103

85104
## Structure

0 commit comments

Comments
 (0)