-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Added release procedure * Improvements according to comments * Improvements according to comments from Hendrik
- Loading branch information
1 parent
b7017e7
commit 60a31e3
Showing
2 changed files
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |