code-server/ci
Anmol Sethi 41ad0c0c4c
release-github-draft.sh: Remove incorrect assets reference
I think at some point this script created the release and attached
assets but that's not the case anymore.

For some reason this would error with undefined variable reference for
joe but bash doesn't complain for me or Asher.

Not sure what the difference is.
2021-02-05 15:11:16 -07:00
..
build release-github-draft.sh: Remove incorrect assets reference 2021-02-05 15:11:16 -07:00
dev chore: add CODE_OF_CONDUCT to fmt script 2021-02-03 09:52:59 -07:00
helm-chart chore: update v to 3.8.1 in values.yaml 2021-02-05 14:11:34 -07:00
images ci: Pin nfpm to v1.9.0 2020-11-16 16:57:04 -05:00
release-image release-image: Use more minimal packages #2462 2020-12-18 13:01:59 -05:00
steps ci: Minor fixes for FreeBSD support 2020-12-18 11:52:08 -05:00
README.md docs: update release doc with rg instructions 2021-02-05 14:10:27 -07:00
lib.sh Fix symlink_asar failing if link is broken 2021-01-05 15:28:42 -06: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 and make a PR.
    1. Update in package.json
    2. Update in ./docs/install.md
    3. Update in ./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.
    4. Update the code coverage badge (see here for instructions)
  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.
  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.
  10. Wait for the npm package to be published.
  11. Update the homebrew package.

Updating Code Coverage in README

Currently, we run a command to manually generate the code coverage shield. Follow these steps:

  1. Run yarn badges
  2. Go into the README and change the color from red to green in this line:
![Lines](https://img.shields.io/badge/Coverage-46.71%25-red.svg)

NOTE: we have to manually change the color because the default is red if coverage is less than 80. See code here.

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-image

This directory contains the release docker container image.

  • ./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
    • 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-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/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.