Skip to content

Commit 834d16d

Browse files
authored
docs(CONTRIBUTING): add standalone release section (#5946)
* docs: update section in troubleshooting * docs: add section on standalone release
1 parent d835cb9 commit 834d16d

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

docs/CONTRIBUTING.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@
1111
- [Version updates to Code](#version-updates-to-code)
1212
- [Patching Code](#patching-code)
1313
- [Build](#build)
14+
- [Creating a Standalone Release](#creating-a-standalone-release)
1415
- [Troubleshooting](#troubleshooting)
1516
- [I see "Forbidden access" when I load code-server in the browser](#i-see-forbidden-access-when-i-load-code-server-in-the-browser)
16-
- ["Can only have one anonymous define call per script"](#can-only-have-one-anonymous-define-call-per-script)
17+
- ["Can only have one anonymous define call per script"](#can-only-have-one-anonymous-define-call-per-script)
1718
- [Help](#help)
1819
- [Test](#test)
1920
- [Unit tests](#unit-tests)
@@ -170,6 +171,22 @@ yarn package
170171
> If you need your builds to support older distros, run the build commands
171172
> inside a Docker container with all the build requirements installed.
172173
174+
#### Creating a Standalone Release
175+
176+
Part of the build process involves creating standalone releases. At the time of
177+
writing, we do this for the following platforms/architectures:
178+
179+
- Linux amd64 (.tar.gz, .deb, and .rpm)
180+
- Linux arm64 (.tar.gz, .deb, and .rpm)
181+
- Linux arm7l (.tar.gz)
182+
- Linux armhf.deb
183+
- Linux armhf.rpm
184+
- macOS amd64 (Intel-based)
185+
186+
Currently, these are compiled in CI using the `yarn release-standalone` command
187+
in the `release.yaml` workflow. We then upload them to the draft release and
188+
distribute via GitHub Releases.
189+
173190
### Troubleshooting
174191

175192
#### I see "Forbidden access" when I load code-server in the browser
@@ -178,7 +195,7 @@ This means your patches didn't apply correctly. We have a patch to remove the au
178195

179196
Try popping off the patches with `quilt pop -a` and reapplying with `quilt push -a`.
180197

181-
### "Can only have one anonymous define call per script"
198+
#### "Can only have one anonymous define call per script"
182199

183200
Code might be trying to use a dev or prod HTML in the wrong context. You can try re-running code-server and setting `VSCODE_DEV=1`.
184201

0 commit comments

Comments
 (0)