mirror of
https://git.tuxpa.in/a/code-server.git
synced 2024-12-29 13:38:46 +00:00
168 lines
8.5 KiB
Markdown
168 lines
8.5 KiB
Markdown
# 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](./lib.sh)
|
|
- Contains code duplicated across these scripts.
|
|
|
|
## Publishing a release
|
|
|
|
Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub) installed.
|
|
|
|
1. Update the version of code-server and make a PR.
|
|
1. Update in `package.json`
|
|
2. Update in [./docs/install.md](../docs/install.md)
|
|
3. Update in [./ci/helm-chart/README.md](../ci/helm-chart/README.md)
|
|
- Remember to update the chart version as well on top of appVersion in `Chart.yaml`.
|
|
- Run `rg -g '!yarn.lock' -g '!*.svg' '3\.7\.5'` to ensure all values have been
|
|
changed. Replace the numbers as needed.
|
|
- You can install `rg` or `ripgrep` on macOS [here](https://formulae.brew.sh/formula/ripgrep).
|
|
4. Update the code coverage badge (see [here](#updating-code-coverage-in-readme) for instructions)
|
|
5. Update the docs badge in [./README.md](../README.md)
|
|
2. GitHub actions will generate the `npm-package`, `release-packages` and `release-images` artifacts.
|
|
1. You do not have to wait for these.
|
|
3. Run `yarn release:github-draft` to create a GitHub draft release from the template with
|
|
the updated version.
|
|
1. Summarize the major changes in the release notes and link to the relevant issues.
|
|
2. Change the @ to target the version branch. Example: `v3.9.0 @ Target: v3.9.0`
|
|
4. Wait for the artifacts in step 2 to build.
|
|
5. Run `yarn release:github-assets` to download the `release-packages` artifact.
|
|
- It will upload them to the draft release.
|
|
6. Run some basic sanity tests on one of the released packages.
|
|
- Especially make sure the terminal works fine.
|
|
7. Make sure the github release tag is the commit with the artifacts. This is a bug in
|
|
`hub` where uploading assets in step 5 will break the tag.
|
|
8. Publish the release and merge the PR.
|
|
1. CI will automatically grab the artifacts and then:
|
|
1. Publish the NPM package from `npm-package`.
|
|
2. Publish the Docker Hub image from `release-images`.
|
|
9. Update the AUR package.
|
|
- Instructions on updating the AUR package are at [cdr/code-server-aur](https://github.com/cdr/code-server-aur).
|
|
10. Wait for the npm package to be published.
|
|
11. Update the [homebrew package](https://github.com/Homebrew/homebrew-core/blob/master/Formula/code-server.rb).
|
|
1. Install [homebrew](https://brew.sh/)
|
|
2. Run `brew bump-formula-pr --version=3.8.1 code-server` and update the version accordingly. This will bump the version and open a PR. Note: this will only work once the version is published on npm.
|
|
|
|
## Updating Code Coverage in README
|
|
|
|
Currently, we run a command to manually generate the code coverage shield. Follow these steps:
|
|
|
|
1. Run `yarn test:unit` and make sure all the tests are passing
|
|
2. Run `yarn badges`
|
|
3. Go into the README and change the color from `red` to `green` in this line:
|
|
|
|
```
|
|
|
|
```
|
|
|
|
NOTE: we have to manually change the color because the default is red if coverage is less than 80. See code [here](https://github.com/olavoparno/istanbul-badges-readme/blob/develop/src/editor.ts#L24-L33).
|
|
|
|
## dev
|
|
|
|
This directory contains scripts used for the development of code-server.
|
|
|
|
- [./ci/dev/image](./dev/image)
|
|
- See [./docs/CONTRIBUTING.md](../docs/CONTRIBUTING.md) for docs on the development container.
|
|
- [./ci/dev/fmt.sh](./dev/fmt.sh) (`yarn fmt`)
|
|
- Runs formatters.
|
|
- [./ci/dev/lint.sh](./dev/lint.sh) (`yarn lint`)
|
|
- Runs linters.
|
|
- [./ci/dev/test-unit.sh](./dev/test-unit.sh) (`yarn test:unit`)
|
|
- Runs unit tests.
|
|
- [./ci/dev/test-e2e.sh](./dev/test-e2e.sh) (`yarn test:e2e`)
|
|
- Runs end-to-end tests.
|
|
- [./ci/dev/ci.sh](./dev/ci.sh) (`yarn ci`)
|
|
- Runs `yarn fmt`, `yarn lint` and `yarn test`.
|
|
- [./ci/dev/watch.ts](./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](../docs/CONTRIBUTING.md).
|
|
- [./ci/dev/gen_icons.sh](./ci/dev/gen_icons.sh) (`yarn icons`)
|
|
- Generates the various icons from a single `.svg` favicon in
|
|
`src/browser/media/favicon.svg`.
|
|
- Requires [imagemagick](https://imagemagick.org/index.php)
|
|
|
|
## 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](./build/build-code-server.sh) (`yarn build`)
|
|
- Builds code-server into `./out` and bundles the frontend into `./dist`.
|
|
- [./ci/build/build-vscode.sh](./build/build-vscode.sh) (`yarn build:vscode`)
|
|
- Builds vscode into `./lib/vscode/out-vscode`.
|
|
- [./ci/build/build-release.sh](./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](./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](./build/clean.sh) (`yarn clean`)
|
|
- Removes all build artifacts.
|
|
- Useful to do a clean build.
|
|
- [./ci/build/code-server.sh](./build/code-server.sh)
|
|
- Copied into standalone releases to run code-server with the bundled node binary.
|
|
- [./ci/build/test-standalone-release.sh](./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](./build/build-packages.sh) (`yarn package`)
|
|
- Packages `./release-standalone` into a `.tar.gz` archive in `./release-packages`.
|
|
- If on linux, [nfpm](https://github.com/goreleaser/nfpm) is used to generate `.deb` and `.rpm`.
|
|
- [./ci/build/nfpm.yaml](./build/nfpm.yaml)
|
|
- Used to configure [nfpm](https://github.com/goreleaser/nfpm) to generate `.deb` and `.rpm`.
|
|
- [./ci/build/code-server-nfpm.sh](./build/code-server-nfpm.sh)
|
|
- Entrypoint script for code-server for `.deb` and `.rpm`.
|
|
- [./ci/build/code-server.service](./build/code-server.service)
|
|
- systemd user service packaged into the `.deb` and `.rpm`.
|
|
- [./ci/build/release-github-draft.sh](./build/release-github-draft.sh) (`yarn release:github-draft`)
|
|
- Uses [hub](https://github.com/github/hub) to create a draft release with a template description.
|
|
- [./ci/build/release-github-assets.sh](./build/release-github-assets.sh) (`yarn release:github-assets`)
|
|
- Downloads the release-package artifacts for the current commit from CI.
|
|
- Uses [hub](https://github.com/github/hub) to upload the artifacts to the release
|
|
specified in `package.json`.
|
|
- [./ci/build/npm-postinstall.sh](./build/npm-postinstall.sh)
|
|
- Post install script for the npm package.
|
|
- Bundled by`yarn release`.
|
|
|
|
## release-image
|
|
|
|
This directory contains the release docker container image.
|
|
|
|
- [./release-image/build.sh](./release-image/build.sh)
|
|
- Builds the release container with the tag `codercom/code-server-$ARCH:$VERSION`.
|
|
- 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](./steps/fmt.sh)
|
|
- Runs `yarn fmt`.
|
|
- [./steps/lint.sh](./steps/lint.sh)
|
|
- Runs `yarn lint`.
|
|
- [./steps/test-unit.sh](./steps/test-unit.sh)
|
|
- Runs `yarn test:unit`.
|
|
- [./steps/test-e2e.sh](./steps/test-e2e.sh)
|
|
- Runs `yarn test:e2e`.
|
|
- [./steps/release.sh](./steps/release.sh)
|
|
- Runs the release process.
|
|
- Generates the npm package at `./release`.
|
|
- [./steps/release-packages.sh](./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](./steps/publish-npm.sh)
|
|
- Grabs the `npm-package` release artifact for the current commit and publishes it on npm.
|
|
- [./steps/build-docker-image.sh](./steps/build-docker-image.sh)
|
|
- Builds the docker image and then saves it into `./release-images/code-server-$ARCH-$VERSION.tar`.
|
|
- [./steps/push-docker-manifest.sh](./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`.
|