VISPA

Development

Development process

We should follow a git workflow with feature and release branches, and release and release candidate tags.

Features and bugfixes

• The master branch is protected and should be kept clean and up-to-date.
• For features, fixes, etc, create feature branches based off the master branch.
• Create merge requests to merge your (tested) feautures back into the master branch.

Releases

• For preparing a release, we create a release/v<major>.<minor> branch based off the master branch.
• Tags of commits on release branches are named v<major>.<minor>.<patch>-<stage>, where the first patch number is 0 and the stage is typically rc0, rc1, etc.
• Use branches prefixed with hotfix/ to fix bugs in release branches.
• When a release is ready to be published, we create a new tag named v<major>.<minor>.<patch>.
• The changes due to hotfixes should be added to the master branch again by either
  • merging without fast-forwarding, or
  • cherrpy-picking certain commits from hotfix branches.

Release and tag versioning

• Release branches: release/v<major>.<minor>
• Tag on release branches: v<major>.<minor>.<patch>-<stage>
• All other tags must not start with v\d.

Branch naming

Except for the master branch, we should use the <purpose>/<description> convention.

purpose should be one of the following:

• <username> for personal branches.
• feature for feature branches.
• fix for bug fixes on the master branch.
• release for final releases (with description as defined above).
• hotfix for bug fixes on release branches.

Docker

You can find all images at our Docker Hub.

We provide a dedicated image containing everything to run the vispa server. This image can also be used for development:

# checkout VISPA 
git checkout git@git.rwth-aachen.de:3pia/vispa.git
cd vispa
 
# run the server inside docker 
docker run --name vispadev -ti -p 4282:4282 -v `pwd`:/vispa/repo 3pia/vispa-server

• --name vispadev names the container "vispadev" so you can start and attach it later on without looking up the hash.
• -ti allocates a pseudo-tty and keeps stdin open.
• -p 4282:4282 publishes the application port (second number) to the host system (first number).
• -v `pwd`:/vispa/repo mounts the current host directory to the container directory that is supposed to contain the vispa repository.

The container is not deleted when you stop it (no --rm parameter). If you want to reattach it to start developing again, do:

docker start vispadev && docker attach vispadev

TODO

Hooks

• server.setup
• server.listen
• socket.started
• db.connection.established
• db.models.loaded
• user.register, user
• user.login, user
• workspace.add, workspace, user