Open main menu

Gramps β

What to do for a release

Revision as of 18:12, 3 December 2016 by Romjerome (talk | contribs) (Include ChangeLog files)
'Developer notes for What to do for a release '


Updated guidelines for Git

Translation update

Run the following steps:

git checkout gramps51
git pull
cd po
  • Translations stuff
python3 -p  
git diff gramps.pot

If there have been changes, you'll need to commit gramps.pot and ask translators to update their .po files before you can make a release.

For checking current translation files:

 python3 -k all

Release name

Refer to (and update) the list of previous releases to select an appropriate name.

Changelog and NEWS file

Look at the changelog:

git log v5.1.5..

Edit and update the NEWS file. Commit the NEWS file:

git commit -am "update for 5.1.5 release"

Working on VERSION

Check gramps/ to indicate an official release:

gedit gramps/ 

and if need, update the version for the release:

VERSION_TUPLE = (4, 2, 0)

Modify gramps/gen/ to indicate an official release:

- VERSION += git_revision
+ #VERSION += git_revision

Save change:

git add .
git commit -am "make official release"

The version number should be the same on "about" dialog:



python3 -v

Create a tag

Create the release tag:

git tag -am "tag 5.1.5" v5.1.5

Tags should be prefixed with the letter v.

Include ChangeLog files

git checkout <tag>
git log v5.1.5.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
git log v5.1.5.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog
git commit -am "Update ChangeLog files"

The Changelog files generated with git2cl.

Push to repository

Push the changes to the repository:

git push origin v5.1.5

Work on tag

Move to the new release number on branch

Bump the version number in gramps/

Update the version for the release:

VERSION_TUPLE = (4, 0, ...)

Revert change on gramps/gen/ to indicate git revision:

- #VERSION += get_git_revision
+ VERSION += get_git_revision

Save change:

git commit -am "bump to <new version number>"
git push

Release from tag

git checkout <tag> -b <new_branch_name>


+ include ChangeLog
+ include po/ChangeLog

Create the official source tarball:

python3 sdist

Making the source tarball available

Create the readme.rst file containing the changes since the previous release.


  • Automatically created when tagged


or via your <dev> account:

$ sftp <dev>
Connecting to
sftp> cd /home/frs/project/gramps/Stable
  • create a new folder in the "Stable" hierarchy
  • put the readme.rst gramps-5.1.5.tar.gz files to the new folder

Announcing the new release

/TOPIC #gramps Welcome to Gramps! The latest versions are 5.1.5 and the legacy 3.4.9 || || Please state OS and Gramps version when asking a question. Understand that replies can take up to 2 days depending on whose watching the channel. Please consider asking on the gramps-users mailing list.

  • update the version number at Wikipedia
  • update mantisdb(Bug/issue database) and enable the new version via Admin:Projects item for reporting issues.


  • merge forward the NEWS file

See also

External links