###############################################################################
#                      Release procedure for developers                       #
###############################################################################

Please follow the step-by-step procedure: 

0/ cd into the root directory of the project (where this file is)

1/ List the changes since the last release in the "ChangeLog" file, with the appropriate syntax (http://en.wikipedia.org/wiki/Changelog).
A good practice is to list changes to an "UNRELEASED" entry as they are made, and finalize this entry with the version number during the Release.

2/ if the command line options for `kissplice` changed, consider updating :
- the manpage at man/kissplice.in.1
- the latex user guide at doc/user_guide.in.tex

3/ change the release numbers `project(VERSION ...)` in the file "CMakeLists.txt"

4/ test the release
make an install, test
make a "local" install (using -DCMAKE_INSTALL_PREFIX), test
test for kmer > 32 (using a k > 32) if you re on a 64bits system (default)
test for kmer < 32

5/ ensure everything is commited and pushed to gitlab : code, changelog file, documentation

6/ create release and tag : https://docs.gitlab.com/ee/user/project/releases/#create-a-release
The simplest way is to use the gitlab interface, which will create both the release entry and a git tag marking the specific commit.

The release page will show the new release, and automatically create downloadable source tar.gz archives : https://gitlab.inria.fr/erable/kissplice/-/releases.
Some "developper only" files are excluded from these archives, see .gitattributes
These archives should work as long as no submodule is added.

Maybe send a notification to users ? kissplice-devel@lists.gforge.inria.fr if it still exists.

# Debian
Kissplice is packaged by the Debian Med team. They track gitlab releases so they should notice them automatically.
Packaging gitlab : https://salsa.debian.org/med-team/kissplice/
Useful documentation : https://med-team.pages.debian.net/policy/

Notable changes to upstream :
- requires bcalm to be an external package. Easy now that the cmake setup defaults to that mode.
- the redirection script to bcalm is replaced by a symlink towards /usr/bin/bcalm