mirror of https://git.tuxpa.in/a/code-server.git
135 lines
6.5 KiB
Markdown
135 lines
6.5 KiB
Markdown
# ci
|
|
|
|
This directory contains scripts used for code-server's continuous integration infrastructure.
|
|
|
|
Many of these scripts contain more detailed documentation and options in comments at the top.
|
|
|
|
Any file and directory added into this tree should be documented here.
|
|
|
|
## 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 in `package.json` and README.md/guide.md install examples and push a commit
|
|
2. GitHub actions will generate the `npm-package` and `release-packages` artifacts
|
|
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.
|
|
4. Wait for the artifacts in step 2 to build
|
|
5. Run `yarn release:github-assets` to download the artifacts 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
|
|
1. Publish the NPM package
|
|
2. Publish the AMD64 docker image
|
|
3. Publish the ARM64 docker image
|
|
|
|
## dev
|
|
|
|
This directory contains scripts used for the development of code-server.
|
|
|
|
- [./dev/container](./dev/container)
|
|
- See [CONTRIBUTING.md](../doc/CONTRIBUTING.md) for docs on the development container
|
|
- [./dev/ci.sh](./dev/ci.sh) (`yarn ci`)
|
|
- Runs `yarn fmt`, `yarn lint` and `yarn test`
|
|
- [./dev/fmt.sh](./dev/fmt.sh) (`yarn fmt`)
|
|
- Runs formatters
|
|
- [./dev/lint.sh](./dev/lint.sh) (`yarn lint`)
|
|
- Runs linters
|
|
- [./dev/test.sh](./dev/test.sh) (`yarn test`)
|
|
- Runs tests
|
|
- [./dev/vscode.sh](./dev/vscode.sh) (`yarn vscode`)
|
|
- Ensures [../lib/vscode](../lib/vscode) is cloned, patched and dependencies are installed
|
|
- [./dev/patch-vscode.sh](./dev/patch-vscode.sh) (`yarn vscode:patch`)
|
|
- Applies [./dev/vscode.patch](./dev/vscode.patch) to [../lib/vscode](../lib/vscode)
|
|
- [./dev/diff-vscode.sh](./dev/diff-vscode.sh) (`yarn vscode:diff`)
|
|
- Diffs [../lib/vscode](../lib/vscode) into [./dev/vscode.patch](./dev/vscode.patch)
|
|
- [./dev/vscode.patch](./dev/vscode.patch)
|
|
- Our patch of VS Code to enable remote browser access
|
|
- Generate it with `yarn vscode:diff` and apply with `yarn vscode:patch`
|
|
- [./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 [CONTRIBUTING.md](../doc/CONTRIBUTING.md)
|
|
|
|
## build
|
|
|
|
This directory contains the scripts used to build and release code-server.
|
|
You can disable minification by setting `MINIFY=`.
|
|
|
|
- [./lib.sh](./lib.sh)
|
|
- Contains code duplicated across these scripts.
|
|
- [./build/build-code-server.sh](./build/build-code-server.sh) (`yarn build`)
|
|
- Builds code-server into ./out and bundles the frontend into ./dist.
|
|
- [./build/build-vscode.sh](./build/build-vscode.sh) (`yarn build:vscode`)
|
|
- Builds vscode into ./lib/vscode/out-vscode.
|
|
- [./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`.
|
|
- [./build/build-static-release.sh](./build/build-static-release.sh) (`yarn release:static`)
|
|
- Requires a release already built in `./release`.
|
|
- Will build a static release with node bundled into `./release-static`
|
|
- [./build/clean.sh](./build/clean.sh) (`yarn clean`)
|
|
- Removes all build artifacts
|
|
- Will also `git reset --hard lib/vscode`
|
|
- Useful to do a clean build
|
|
- [./build/code-server.sh](./build/code-server.sh)
|
|
- Copied into static releases to run code-server with the bundled node binary.
|
|
- [./build/test-static-release.sh](./build/test-static-release.sh) (`yarn test:static-release`)
|
|
- Ensures code-server in the `./release-static` directory runs
|
|
- [./build/build-packages.sh](./build/build-packages.sh) (`yarn package`)
|
|
- Packages `./release-static` into an archive in `./release-packages`
|
|
- If on linux, [nfpm](https://github.com/goreleaser/nfpm) is used to generate .deb and .rpm
|
|
- [./build/nfpm.yaml](./build/nfpm.yaml)
|
|
- Used to configure [nfpm](https://github.com/goreleaser/nfpm) to generate .deb and .rpm
|
|
- [./build/code-server-nfpm.sh](./build/code-server-nfpm.sh)
|
|
- Entrypoint script for code-server for .deb and .rpm
|
|
- [./build/code-server.service](./build/code-server.service)
|
|
- systemd user service packaged into the debs and rpms
|
|
- [./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
|
|
- [./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`
|
|
- [./build/npm-postinstall.sh](./build/npm-postinstall.sh)
|
|
- Post install script for the npm package
|
|
- Bundled by`yarn release`
|
|
|
|
## release-container
|
|
|
|
This directory contains the release docker container.
|
|
|
|
- [./release-container/build.sh](./release-container/build.sh)
|
|
- Builds the release container
|
|
- Assumes debian releases are ready in `./release-packages`
|
|
- [./release-container/push.sh](./release-container/push.sh)
|
|
- Pushes the built release container to docker hub and updates the latest tag
|
|
|
|
## container
|
|
|
|
This directory contains the container for CI.
|
|
|
|
## steps
|
|
|
|
This directory contains a few scripts used in CI.
|
|
Just helps avoid clobbering the CI configuration.
|
|
|
|
- [./steps/fmt.sh](./steps/fmt.sh)
|
|
- Runs `yarn fmt` after ensuring VS Code is patched
|
|
- [./steps/lint.sh](./steps/lint.sh)
|
|
- Runs `yarn lint` after ensuring VS Code is patched
|
|
- [./steps/test.sh](./steps/test.sh)
|
|
- Runs `yarn test` after ensuring VS Code is patched
|
|
- [./steps/release.sh](./steps/release.sh)
|
|
- Runs the full release process
|
|
- Generates the npm package at `./release`
|
|
- [./steps/static-release.sh](./steps/static-release.sh)
|
|
- Takes the output of the previous script and generates a static release and packages
|
|
- [./steps/lib.sh](./steps/lib.sh)
|
|
- Contains helpers to download artifacts from github actions workflow runs
|
|
- [./steps/publish-npm.sh](./steps/publish-npm.sh)
|
|
- Grabs the `npm-package` release artifact for the current commit and publishes it on NPM
|
|
- [./steps/publish-docker.sh](./steps/publish-docker.sh)
|
|
- Grabs the `release-packages` release artifact for the current commit and
|
|
builds a docker image with it and publishes that onto docker hub with the
|
|
correct tag and updates latest
|