diff --git a/README.md b/README.md index 62f95592702e0d35c9968bfe815ba6353a5cca20..8f23aa7d6d7c5c9cbeb063deec8e9a9dc9f461fe 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ docker run -it -p 127.0.0.1:8080:8080 \ codercom/code-server:latest ``` -### Self contained releases +### Static releases We publish self contained `.tar.gz` archives for every release on [github](https://github.com/cdr/code-server/releases). They bundle the node binary and compiled native modules. @@ -81,7 +81,7 @@ They bundle the node binary and compiled native modules. Add the code-server `bin` directory to your `$PATH` to easily execute `code-server` without the full path every time. -Here is an example script for installing and using a self-contained `code-server` release on Linux: +Here is an example script for installing and using a static `code-server` release on Linux: ```bash curl -sSL https://github.com/cdr/code-server/releases/download/3.3.0/code-server-3.3.0-linux-amd64.tar.gz | sudo tar -C /usr/local -xz diff --git a/ci/README.md b/ci/README.md index aa0dd5a3288d9b94c3a594190ac28253d0a94233..3fc3e7ff5d5ee3621e3c1865f81b6a356b2afe22 100644 --- a/ci/README.md +++ b/ci/README.md @@ -20,7 +20,8 @@ Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub) the updated version. 1. Summarize the major changes in the release notes and link to the relevant issues. 4. Wait for the artifacts in step 2 to build. -5. Run `yarn release:github-assets` to download the `release-packages` artifact and then upload them to the draft release. +5. Run `yarn release:github-assets` to download the `release-packages` artifact and then + upload them to the draft release. 6. Run some basic sanity tests on one of the released packages. 7. Publish the release. 1. CI will automatically grab the artifacts and then: @@ -123,7 +124,7 @@ Helps avoid clobbering the CI configuration. - Runs the release process. - Generates the npm package at `./release`. - [./steps/release-static.sh](./steps/release-static.sh) - - Takes the output of the previous script and generates a self-contained release and + - Takes the output of the previous script and generates a static release and release packages into `release-packages`. - [./steps/publish-npm.sh](./steps/publish-npm.sh) - Grabs the `npm-package` release artifact for the current commit and publishes it on npm. diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md index 239560599e6d567b5377f349817201b16fcddbfe..51609f946e1b4e89522110b4432c8c714981fa1e 100644 --- a/doc/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -57,7 +57,7 @@ yarn release:static yarn test:static-release yarn package # The static release is in ./release-static -# .deb, .rpm and the self-contained archive are in ./release-packages +# .deb, .rpm and the static archive are in ./release-packages ``` ## Structure