What to do for a release

From Gramps
Revision as of 07:05, 19 May 2012 by Stephanecharette (talk | contribs) (Reverted edits by Romjerome (talk) to last revision by PaulFranklin2)
Jump to: navigation, search

What to do for a release

These notes are based on version 3.3.0, released in June 2011. The steps assume a working gramps33 source directory. See Running a development version of Gramps if this is not the case.

Translation update

Run the following steps:

cd gramps33
svn update
cd po
make gramps.pot
svn 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.

Release name

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

Changelog and NEWS file

Create the changelog files:

svn2cl --reparagraph --include-rev --authors=src/data/authors.xml
cd po
svn2cl --reparagraph --include-rev --authors=../src/data/authors.xml
cd ..

Using the Changelog files generated with svn2cl in the step above, edit and update the NEWS file. Commit the NEWS file. Note the svn commit revision number, which you'll need in the next step when you create the subversion tag:

svn commit -m "update for 3.3.0 release"
Committed revision 17751.

Subversion tag

Using the previous commit revision number, create a tag for the new release:

svn copy -r 17751 https://gramps.svn.sourceforge.net/svnroot/gramps/branches/maintenance/gramps33 https://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.3.0 -m "tag 3.3.0"
Committed revision 17752.

Working on the tag

Check out the new tag:

cd ..
svn co https://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.3.0
cd gramps-3.3.0

Modify configure.in to indicate an official release:

gedit configure.in

There are two changes to make:

1) Change the following line:
-RELEASE=0.SVN$(svnversion -n .)
+dnl RELEASE=0.SVN$(svnversion -n .)
2) And change this line:
-dnl RELEASE=1

Save these two changes.

svn commit -m "make official release" configure.in

Now run the following and check the version number in the "about" dialog:

python src/gramps.py

Changelog and source tarball

Re-create (or copy from above) the 2 Changelog files. The Changelog files are required for the source tarball, but do not commit to subversion:

svn2cl --reparagraph --include-rev --authors=src/data/authors.xml
cd po
svn2cl --reparagraph --include-rev --authors=../src/data/authors.xml
cd ..

Create the official source tarball:

make distcheck

Note you should now have the file gramps-3.3.0.tar.gz, approximately 8 MB in size.

Making the source tarball available

Announcing the new release

  • announce on gramps-announce@lists.sourceforge.net, gramps-devel@lists.sourceforge.net and gramps-users@lists.sourceforge.net
  • update News section on this wiki
  • update the list of previous releases
  • update reference to the new version on the wiki template
  • change the topic on the IRC channel #gramps
  • update the version number at Wikipedia


  • in gramps33, bump the version number in configure.in and src/const.py.in
  • in trunk, merge forward the NEWS file

See also

External links