History

Joe Previte e7e6c163ed revert(docs): partially revert `326a1d1862` (#5095 ) We tried to switch from `yarn` to `npm` because `yarn` ignores lockfiles but learned that we missed a few key things. For now, we are reverting docs and a few other changes that suggested using `npm` instead of `yarn` until we fully remove `yarn` from the codebase. t Please enter the commit message for your changes. Lines starting		2022-04-13 17:15:21 +00:00
..
build	chore: remove file ext. from LICENSE (#5070 )	2022-04-07 10:36:33 -07:00
dev	chore: move to patches (#4997 )	2022-03-22 15:07:14 -05:00
helm-chart	docs(helm): add example env required for docker-in-docker (#5045 )	2022-03-30 11:19:58 -07:00
release-image	Exclude .deb files from release Docker image (#5068 )	2022-04-06 15:45:06 -07:00
steps	revert(docs): partially revert `326a1d1862` (#5095 )	2022-04-13 17:15:21 +00:00
README.md	fix(ci): build+push image in release flow (#3838 )	2021-07-29 23:31:46 +05:30
lib.sh	chore: move Code to a submodule (#4990 )	2022-03-14 21:37:29 -05:00

README.md

ci

This directory contains scripts used for code-server's continuous integration infrastructure.

Some of these scripts contain more detailed documentation and options in header comments.

Any file or directory in this subdirectory should be documented here.

./ci/lib.sh
- Contains code duplicated across these scripts.

dev

This directory contains scripts used for the development of code-server.

./ci/dev/image
- See ./docs/CONTRIBUTING.md for docs on the development container.
./ci/dev/fmt.sh (yarn fmt)
- Runs formatters.
./ci/dev/lint.sh (yarn lint)
- Runs linters.
./ci/dev/test-unit.sh (yarn test:unit)
- Runs unit tests.
./ci/dev/test-e2e.sh (yarn test:e2e)
- Runs end-to-end tests.
./ci/dev/ci.sh (yarn ci)
- Runs yarn fmt, yarn lint and yarn test.
./ci/dev/watch.ts (yarn watch)
- Starts a process to build and launch code-server and restart on any code changes.
- Example usage in ./docs/CONTRIBUTING.md.
./ci/dev/gen_icons.sh (yarn icons)
- Generates the various icons from a single .svg favicon in src/browser/media/favicon.svg.
- Requires imagemagick

build

This directory contains the scripts used to build and release code-server. You can disable minification by setting MINIFY=.

./ci/build/build-code-server.sh (yarn build)
- Builds code-server into ./out and bundles the frontend into ./dist.
./ci/build/build-vscode.sh (yarn build:vscode)
- Builds vscode into ./lib/vscode/out-vscode.
./ci/build/build-release.sh (yarn release)
- Bundles the output of the above two scripts into a single node module at ./release.
./ci/build/build-standalone-release.sh (yarn release:standalone)
- Requires a node module already built into ./release with the above script.
- Will build a standalone release with node and node_modules bundled into ./release-standalone.
./ci/build/clean.sh (yarn clean)
- Removes all build artifacts.
- Useful to do a clean build.
./ci/build/code-server.sh
- Copied into standalone releases to run code-server with the bundled node binary.
./ci/build/test-standalone-release.sh (yarn test:standalone-release)
- Ensures code-server in the ./release-standalone directory works by installing an extension.
./ci/build/build-packages.sh (yarn package)
- Packages ./release-standalone into a .tar.gz archive in ./release-packages.
- If on linux, nfpm is used to generate .deb and .rpm.
./ci/build/nfpm.yaml
- Used to configure nfpm to generate .deb and .rpm.
./ci/build/code-server-nfpm.sh
- Entrypoint script for code-server for .deb and .rpm.
./ci/build/code-server.service
- systemd user service packaged into the .deb and .rpm.
./ci/build/release-github-draft.sh (yarn release:github-draft)
- Uses gh to create a draft release with a template description.
./ci/build/release-github-assets.sh (yarn release:github-assets)
- Downloads the release-package artifacts for the current commit from CI.
- Uses gh to upload the artifacts to the release specified in package.json.
./ci/build/npm-postinstall.sh
- Post install script for the npm package.
- Bundled byyarn release.

release-image

This directory contains the release docker container image.

./ci/steps/build-docker-buildx-push.sh
- Builds the release containers with tags codercom/code-server-$ARCH:$VERSION for amd64 and arm64 with docker buildx and pushes them.
- Assumes debian releases are ready in ./release-packages.

images

This directory contains the images for CI.

steps

This directory contains the scripts used in CI. Helps avoid clobbering the CI configuration.

./steps/fmt.sh
- Runs yarn fmt.
./steps/lint.sh
- Runs yarn lint.
./steps/test-unit.sh
- Runs yarn test:unit.
./steps/test-e2e.sh
- Runs yarn test:e2e.
./steps/release.sh
- Runs the release process.
- Generates the npm package at ./release.
./steps/release-packages.sh
- Takes the output of the previous script and generates a standalone release and release packages into ./release-packages.
./steps/publish-npm.sh
- Grabs the npm-package release artifact for the current commit and publishes it on npm.
./steps/docker-buildx-push.sh
- Builds the docker image and then pushes it.
./steps/push-docker-manifest.sh
- Loads all images in ./release-images and then builds and pushes a multi architecture docker manifest for the amd64 and arm64 images to codercom/code-server:$VERSION and codercom/code-server:latest.