Skip to content
This repository has been archived by the owner on Sep 2, 2021. It is now read-only.

Latest commit

 

History

History
32 lines (21 loc) · 1.72 KB

RELEASE.md

File metadata and controls

32 lines (21 loc) · 1.72 KB
Raw

Making a Galata Release

  1. Bump the Galata version in packages/galata/package.json. Also update example project's Galata dependency version to match, in packages/galata-example/package.json.

    Galata package needs to be versioned with the same major, minor and patch versions as the JupyterLab it is made for. For example, if Galata is based on JupyterLab 3.0.1, a valid Galata version is 3.0.1-1 to 3.0.1-n. This version matching is enforced before Galata packages are published.

    JupyterLab version, that Galata is made for, is determined by @jupyterlab/application dependency version in the yarn.lock. If the JupyterLab version is not changing with the new Galata release then only increment the release number after - (for example 3.0.1-2 to 3.0.1-3). However, if JupyterLab version is changing with the new Galata release then reset the release number after - to 1 (for example 3.0.1-3 to 3.0.2-1).

  2. Re-install dependencies and rebuild.

yarn
yarn run build
  1. Run tests and make sure that all pass. Before running tests, JupyterLab must be up and running. You can use the launch command described in Launch JupyterLab section of README.md
yarn run test

  1. Commit your version changes.

  2. Once version update is in the main branch, publish a new release on GitHub (https://github.com/jupyterlab/galata/releases) with the list of changes in the description.

  3. Pull latest of main branch and publish npm package to npm registry. You will need an npmjs.org account to be able to publish this package.

cd packages/galata
npm login --registry https://registry.npmjs.org
npm publish