What to do for a release
What to do for a release
Contents
- 1 Updated guidelines for Git
- 2 Guidelines for version 4.0
- 3 See also
- 4 External links
Updated guidelines for Git
Translation update
Run the following steps:
git checkout gramps40 git pull cd po python update_po.py -p # or intltool-update -p , .genpot.sh see New environment 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.
Release name
Refer to (and update) the list of previous releases to select an appropriate name.
Changelog and NEWS file
Create the changelog files:
git log gramps-4.0.1.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog git log gramps-4.0.1.. --pretty --numstat --summary --no-merges -- po | git2cl > po/ChangeLog
Using the Changelog files generated with git2cl in the step above, edit and update the NEWS file. Commit the NEWS file:
git commit -am "update for 4.0.2 release"
Working on VERSION
- 4.0.x
Modify version.py to indicate an official release:
gedit gramps/version.py
and update the version for the release:
VERSION_TUPLE = (4, 0, 2)
Save change:
git commit -am "make official release"
The version number should be the same on "about" dialog:
python Gramps.py
- 3.4.x
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 +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:
./autogen.sh make python src/gramps.py
Create a tag
Create the release tag:
git tag -am "tag 4.0.2" gramps-4.0.2
Push to repository
Push the changes to the repository:
git push origin gramps-4.0.2
Work on tag
Move to the new release number on branch
- 4.0.x
bump the version number in gramps/version.py
- 3.4.x
bump the version number in configure.in and src/const.py.in
Release from tag
git checkout <tag> -b <new_branch_name>
- Gramps-4.0.x
Modify MANIFEST.in
+ include ChangeLog
Create the official source tarball:
python setup.py sdist
- Gramps-3.4
Build, check and create the official source tarball:
./autogen.sh make distcheck
Changelog and source tarball
The Changelog files are required for the source tarball, but do not commit them to Git.
- 4.0.x
- Modify MANIFEST.in
+ include ChangeLog
Create the official source tarball:
python setup.py sdist
Note you should now have the file dist/gramps-4.0.2.tar.gz, approximately 14.7 Mo in size.
- 3.4.x
Making the source tarball available
- access the "Sourceforge Project Admin->File Manager" page at https://sourceforge.net/projects/gramps/
- create a new folder in the "Stable" hierarchy
- upload the gramps-*.tar.gz file to the new folder
Announcing the new release
- announce on [email protected], [email protected] and [email protected]
- 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
- announce freshmeat now known as freecode, this is also a feed on the slashdot front page
Post-release
- merge forward the NEWS file
Guidelines for version 4.0
These notes are based on version 4.0.0alpha1, released in December 2012. The steps assume a working gramps40 source directory.
Translation update
Run the following steps:
cd gramps40 svn update cd po python update_po.py -p # or intltool-update -p , .genpot.sh see New environment 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=data/authors.xml cd po svn2cl --reparagraph --include-rev --authors=../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 4.0.0-alpha1 release" Committed revision 20810.
Working on VERSION
Modify version.py to indicate an official release:
gedit gramps/version.py
and update the version for the release:
VERSION_TUPLE = (4, 0, 0)
Save change.
svn commit -m "make official release" gramps/version.py
The version number should be the same on "about" dialog:
python Gramps.py
Subversion tag
Using the previous commit revision number, create a tag for the new release:
svn copy -r 22385 https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps40 https://svn.code.sf.net/p/gramps/code/tags/gramps-4.0.0 -m "tag 4.0.0" Committed revision 22386.
Changelog and source tarball
The Changelog files are required for the source tarball, but do not commit them to subversion.
- Copy files from previous run under branch.
- Modify MANIFEST.in
+ include ChangeLog
Create the official source tarball:
python setup.py sdist
Note you should now have the file dist/gramps-4.0.0.tar.gz, approximately 14.7 Mo in size.
Making the source tarball available
- access the "Sourceforge Project Admin->File Manager" page at https://sourceforge.net/projects/gramps/
- create a new folder in the "Stable" hierarchy
- upload the gramps-*.tar.gz file to the new folder
Announcing the new release
- announce on [email protected], [email protected] and [email protected]
- 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
- announce freshmeat now known as freecode, this is also a feed on the slashdot front page
Post-release
- bump the version number in gramps/version.py
- in trunk, merge forward the NEWS file