Release documentation

Release process

1 Tests

On Macos set limits:

$ sudo launchctl limit maxfiles 65536 200000

On Windows one needs OpenSSH 8 for the tests:

C:\>choco install openssh

set SSH=C:\Program Files\OpenSSH-Win64\ssh.exe

C:\> cmd /c ""%SSH%"" -V
OpenSSH_for_Windows_8.0p1, LibreSSL 2.6.5

Note: This assumes that https://chocolatey.org is installed

Copy config-template.yaml to config.yaml and edit it accordingly
Depending on whether test should be run against AWS or Azure, set one of
```
$ export CLOUD=aws
$ export CLOUD=azure
```
or under Windows one of
```
C:\>set CLOUD=aws
C:\>set CLOUD=azure
```

Start clusters

python 00-create-clusters.py

or restart clusters:

python 01-restart-clusters.py

Create secret scope and key for tests (if not already exists)
```
python 05-create-secret-scope.py
```
Execute tests Note: For dev tests (the current version is not published to pypi), enable 03-install-wheel_test.py, i.e. comment the skip marks decorating the test.

Execute the tests
```
pytest -v -o log_cli=true
```
Remove clusters
```
python 99-destroy-clusters.py
```

2 Labextension

In case the jupyter labextions has been changed:

Commit changes
Bump version of databrickslabs_jupyterlab_statusbar
- A new release candidate with rc0
```
make bump_ext part=premajor|preminor|prepatch
```
- A new build
```
make bump_ext part=prerelease
```
- A new release without release candidate
```
make bump_ext version=major.minor.patch
```
Deploy to npmjs.com
```
make upload_ext
```
Process with Python package since labextensions.txt is changed!

3 Python package

In case the jupyter labextions and/or the python code has been changed:

Run tests
```
make tests
```

Clean environment

make clean    # delete all temp files
make prepare  # commit deletions

Bump version of databrickslabs_jupyterlab
- A new release candidate with rc0
```
make bump part=major|minor|patch
```
- A new build
```
make bump part=build
```
- A new release
```
make bump part=release
```
- A new release without release candidate
```
make bump part=major|minor|patch version=major.minor.patch
```
Create distribution
```
make dist
```
Create and tag release
```
make release
```
Deploy to pypi
```
make upload
```

4 Docker image

Create docker image
```
make docker
```
Publish image
```
make upload_docker
```

5 Push changes

Push repo and tag

git push --no-verify
git push origin --no-verify --tags