Skip to content

doc: Simplify build process docs #2004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 26, 2020
Merged

doc: Simplify build process docs #2004

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2495cf
doc: Simplify build process docs
nhooyr Aug 26, 2020
8e097c4
fixup! doc: Simplify build process docs
nhooyr Aug 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions doc/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,10 @@ reset VS Code then run `yarn vscode:patch`.

## Build

The script we run in CI that does all the above
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does "all the above" refer to the development steps? Or should this say "below" in reference to the list of what it includes below?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no sry this was just a brainfart lol.


```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.
Expand All @@ -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
Expand Down