mirror of https://github.com/danog/code-server.git synced 2024-11-26 20:34:56 +01:00

History

Joe Previte c51ff3bce1 refactor: move integration tests to Jest (#5275 ) * feat: add installExtension integration test This adds a new helper function called `runCodeServerCommand` along with a test for `--install-extension`. We can use this approach for writing integration tests (i.e. testing a real code-server build, CLI commands, etc). * refactor: s/ test:standalone with test:integration This replaces our integration approach to use Jest instead of a single bash script. By doing this, we will be able to easily maintain and add to our integration test suite. * refactor: filter unit tests Now that our integration tests also use Jest, we need to update our unit test script to ignore `test/integration`. * refactor: add SKIP_SUBMODULE_DEPS to postinstall * refactor: add SKIP_SUBMODULE_DEPS to postinstall * fixup!: skip submod deps * refactor: move runCodeServerCommand into sep. file When Jest runs a test, it loads all the files and imports for that test. This means you might be "requiring" code that's unrelated to your tests. This leads to unexpected errors depending on where the code runs. Moved this file to avoid GLIBC and other errors relaed to argon2 when running integration tests in CI. * fizup: formatting * fizup: increase timeout * refactor: use fixture in installExtension test Instead of relying on a network to install an extension, we use a fixture - vsix file in the repo. This is also faster. * feat: add integration test for listExtensions * chore: ignore integration fixtures * fixup: formatting * fixup: remove custom-hacks.css * fixup: formatting * Update test/integration/installExtension.test.ts Co-authored-by: Asher <ash@coder.com> * Update test/integration/listExtensions.test.ts Co-authored-by: Asher <ash@coder.com> * Update test/integration/installExtension.test.ts Co-authored-by: Asher <ash@coder.com> * Update test/integration/listExtensions.test.ts Co-authored-by: Asher <ash@coder.com> * fixup: contributing integration tests section * fixup: update ci/readme * fixup: use RELEASE_PATH in test-integration.sh * refactor: unzip vsix for listExtensions * refactor: use exec instead of spawn * Update docs/CONTRIBUTING.md Co-authored-by: Asher <ash@coder.com> * Update test/integration/listExtensions.test.ts Co-authored-by: Asher <ash@coder.com> * Update test/integration/listExtensions.test.ts Co-authored-by: Asher <ash@coder.com> * Update test/integration/listExtensions.test.ts Co-authored-by: Asher <ash@coder.com> * refactor: use different default binary path * fixup!: formatting Co-authored-by: Asher <ash@coder.com>		2022-06-24 16:33:38 +00:00
..
build	refactor: move integration tests to Jest (#5275 )	2022-06-24 16:33:38 +00:00
dev	refactor: move integration tests to Jest (#5275 )	2022-06-24 16:33:38 +00:00
helm-chart	release: 4.4.0 (#5169 )	2022-05-06 13:45:49 -07:00
release-image	Allow user Entrypoint scripts (#5194 )	2022-05-11 22:10:04 +00:00
steps	revert(docs): partially revert `326a1d1862` (#5095 )	2022-04-13 17:15:21 +00:00
lib.sh	chore: move Code to a submodule (#4990 )	2022-03-14 21:37:29 -05:00
README.md	refactor: move integration tests to Jest (#5275 )	2022-06-24 16:33:38 +00: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/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-integration.sh
- Runs yarn test:integration.
./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.