code-server/ci
Anmol Sethi b9f43c3542
Fix grammar in FAQ
2020-05-17 20:29:00 -04:00
..
build Fix grammar in FAQ 2020-05-17 20:29:00 -04:00
container Push docker manifest in CI for multi arch image 2020-05-16 16:59:26 -04:00
dev Document structure better 2020-05-17 16:53:08 -04:00
release-container Push docker manifest in CI for multi arch image 2020-05-16 16:59:26 -04:00
steps Document structure better 2020-05-17 16:53:08 -04:00
README.md Rename self contained release to static release 2020-05-17 16:59:09 -04:00
lib.sh Push docker manifest in CI for multi arch image 2020-05-16 16:59:26 -04: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.

Publishing a release

Make sure you have $GITHUB_TOKEN set and 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, release-packages and release-images 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 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:
      1. Publish the NPM package from npm-package.
      2. Publish the Docker Hub image from release-images.
  8. Update the homebrew and AUR packages.

dev

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

build

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

release-container

This directory contains the release docker container.

  • ./release-container/build.sh
    • Builds the release container with the tag codercom/code-server-$ARCH:$VERSION.
    • Assumes debian releases are ready in ./release-packages.

container

This directory contains the container for CI.

steps

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

  • ./steps/fmt.sh
    • Runs yarn fmt after ensuring VS Code is patched.
  • ./steps/lint.sh
    • Runs yarn lint after ensuring VS Code is patched.
  • ./steps/test.sh
    • Runs yarn test after ensuring VS Code is patched.
  • ./steps/release.sh
    • Runs the release process.
    • Generates the npm package at ./release.
  • ./steps/release-static.sh
    • Takes the output of the previous script and generates a static 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/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
    • 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.