Permalink
Browse files

Added release procedure (#107)

* Added release procedure

* Improvements according to comments

* Improvements according to comments from Hendrik
  • Loading branch information...
amit-cliqz committed Sep 25, 2018
1 parent b7017e7 commit 60a31e3949cf96ac3fd510e1bb620b07028eeedd
Showing with 30 additions and 0 deletions.
  1. +3 −0 README.md
  2. +27 −0 doc/RELEASE_PROCESS.md
@@ -58,6 +58,9 @@ If you like to go deep down in the basics, keyvi is inspired by the following 2
* Sparse Array (See Storing a Sparse Table, Robert E. Tarjan et al. http://infolab.stanford.edu/pub/cstr/reports/cs/tr/78/683/CS-TR-78-683.pdf)
* Incremental, which means minimization is done on the fly (See Incremental Construction of Minimal Acyclic Finite-State Automata, J. Daciuk et al.: http://www.mitpressjournals.org/doi/pdf/10.1162/089120100561601)
## Release procedure
* [How to make a release](doc/Release_Process.md)
## Licence and 3rdparty dependencies
@@ -0,0 +1,27 @@
# How to make a keyvi release (e.g., vX.Y.Z)
## Create a release branch
Create a release branch called `release-X.Y.Z`
## On the `release-X.Y.Z` branch
### Update the `setup.py` file
- Update the flag `IS_RELEASED` to `True`
- Commit to `release-X.Y.Z` and push it to https://github.com/KeyviDev/keyvi/
- Wait for travis to build all targets
### Create tag
- Draft a new release tagged vX.Y.Z with `release-X.Y.Z` as the target branch
- Add the release notes in the description with references to PRs
- Publish release
## On the `master` branch
### Update the `setup.py` file
- Update to the next release version
```
VERSION_MAJOR = X
VERSION_MINOR = Y
VERSION_PATCH = Z + 1
VERSION_DEV = 0
```

0 comments on commit 60a31e3

Please sign in to comment.