Open main menu

Gramps β

Changes

What to do for a release

1,480 bytes added, 03:34, 4 October 2015
Release from tag
'''What to do for a release''' These notes are based on version 3.4.1, released in August 2012. The steps assume a working <tt>gramps34</tt> source directory. See [[Running a development version of Gramps]] if this is not the case.=Updated guidelines for Git =
==Translation update==
Run the following steps:
cd gramps34git checkout gramps{{Stable_branch}} svn updategit pull
cd po
For Gramps 3.4 and earlier use: make ./genpot.shFor Gramps 4.x use (See [[Translation_environment4|New environment]] and [[Talk:Translation_environment4|differences between tools]]. See [https://github.com/gramps-project/gramps/blob/master/po/update_po.py po/update_po.py] to generate a new template/catalog (gramps.pot).) python update_po.py -p svn git diff gramps.pot
If there have been changes, you'll need to commit <tt>gramps.pot</tt> and ask translators to update their <tt>.po</tt> files before you can make a release.
==Release name==
Refer to (and update) the [[Previous releasesof Gramps|list of previous releases]] to select an appropriate name.
==Changelog and NEWS file==
Create the changelog files:
svn2cl git log gramps-{{version}}.. --pretty -reparagraph -numstat -include-rev summary --authors=src/data/authors.xmlno-merges | git2cl > ChangeLog cd po svn2cl git log gramps-{{version}}.. --pretty --numstat --reparagraph summary --includeno-rev merges --authorspo/*.po | git2cl > po/ChangeLog Using the <tt>Changelog</tt> files generated with <tt>git2cl</tt> in the step above, edit and update the <tt>NEWS</tt> file.Commit the NEWS file: git commit -am "update for {{version}} release" ==Working on VERSION== ===Gramps 4.2.x===* 4.2.x Check <tt>[https://github.com/gramps-project/gramps/blob/srcmaster/datagramps/version.py gramps/authorsversion.xmlpy]</tt> to indicate an official release: cd gedit gramps/version.py  and if need, update the version for the release: VERSION_TUPLE = (4, 2, 0) Modify <tt>[https://github.com/gramps-project/gramps/blob/master/gramps/gen/const.py#L132 gramps/gen/const.py]</tt> to indicate an official release: - VERSION += git_revision + VERSION += "-1"
Using the <tt>Changelog</tt> files generated with <tt>svn2cl</tt> in the step above, edit and update the <tt>NEWS</tt> file.Save change:Commit the NEWS file git add . Note the svn commit revision number, which you'll need in the next step when you create the subversion tag: svn git commit -m am "update for 3.4.1 make official release" Committed revision 20254.
==Subversion tag==Using the previous commit revision The version number, create a tag for should be the new releasesame on "about" dialog: svn copy -r 20254 https://grampspython Gramps.svn.sourceforge.net/svnroot/gramps/branches/maintenance/gramps34 https://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.4.1 -m "tag 3.4.1"pyor Committed revision 20255python Gramps.py -v
==Working on the tag==Check out the new tag: cd .. svn co https://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-Gramps 3.4.1x=== cd gramps-* 3.4.1x
Modify <tt>configure.in</tt> to indicate an official release:
There are two changes to make:
:1) Change the following line:
-RELEASE=0.SVN$(svnversion git log -n 1 --format=%h .) +dnl RELEASE=0.SVN$(svnversion git log -1 -n -format=%h .)
:2) And change this line:
-dnl RELEASE=1
+RELEASE=1
Save these two changes.
svn git commit -m am "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
==Changelog and source tarballCreate a tag==Create the release tag: git tag -am "tag {{version}}" gramps-{{version}} ==Push to repository==RePush the changes to the repository: git push origin gramps-create (or copy from above) {{version}} ==Work on tag == ===Move to the new release number on branch =======Gramps 4.2 Changelog files. The Changelog files are required x====* 4.0.x Bump the version number in <tt>gramps/version.py</tt> Update the version for the source tarballrelease: VERSION_TUPLE = (4, 0, but do not commit ...) Revert change on <tt>gramps/gen/const.py</tt> to subversionindicate git revision: svn2cl -VERSION += "-reparagraph 1" + VERSION += get_git_revision(ROOT_DIR) Save change: git commit --include-rev --authorsam "bump to <new version number>" git push ====Gramps 3.4.x====* 3.4.x Bump the version number in <tt>configure.in</tt> and <tt>src/dataconst.py.in</authors.xmltt> Save change: git commit -am "bump to <new version number>" cd pogit push ===Release from tag===  svn2cl git checkout <tag> -b <new_branch_name> ====Gramps 4.2.x====* Gramps-reparagraph --include-rev --authors=4.0.x Modify <tt>MANIFEST.in</srctt> + include ChangeLog + include po/data/authors.xmlChangeLog cd ..
Create the official source tarball:
 
python setup.py sdist
 
====Gramps 3.4.x====
* Gramps-3.4
 
Build, check and create the official source tarball:
 
./autogen.sh
make distcheck
 
Note you should now have the file <tt>gramps-3.4.1.tar.gz</tt>, approximately 8 MB in size.
==Making the source tarball available==
* access the "Sourceforge Project Admin->File Manager" page at https://sourceforge.net/projects/gramps/
or via your ''<dev>'' account:
$ sftp <dev>@frs.sourceforge.net
Connecting to frs.sourceforge.net...
Password:
sftp> cd /home/frs/project/gramps
* create a new folder in the "Stable" hierarchy
* upload the <tt>gramps-*{{version}}.tar.gz</tt> file to the new folder
==Announcing the new release==
* update [[News]] section on this wiki
* update the list of [[Previous releases of Gramps|previous releases]]
* update reference to the new version on the [[Template:Version|wiki template]]
* update [[HeadlineNews]]
* change the topic on the IRC channel #gramps
<code> /TOPIC #gramps Welcome to Gramps! The latest versions are 4.2.0 and the legacy 3.4.9 || http://www.gramps-project.org/ || 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. </code>* update the version number at [http://en.wikipedia.org/wiki/GRAMPS Gramps Wikipedia]
==Post-release==
* in <tt>gramps34</tt>, bump the version number in <tt>configure.in</tt> and <tt>src/const.py.in</tt>* in <tt>trunk</tt>, merge forward the <tt>NEWS</tt> file
==See also==* [[Git|Brief introduction to SVNGit]]
* [[Running a development version of Gramps]]
* [[:Category:Developers/Packaging]]
==External links==* httphttps://grampsgithub.svn.sourceforge.net/viewvccom/gramps/-project
* http://gramps-project.org/cpanel
* http://svn.code.sf.net/p/gramps/code/
* http://sourceforge.net/projects/gramps/
[[Category:Developers/General]]