Open main menu

Gramps β

Changes

What to do for a release

737 bytes added, 17:00, 6 January 2016
m
Gramps 4.2.x
'''What to do for a release''' These notes are based on version 3.3.0, released in June 2011. The steps assume a working <tt>gramps{{stable_branch}}</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 git checkout gramps{{stable_branchStable_branch}} svn updategit pull
cd po
make ===Gramps 4.x===For 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 v{{version}}.. --reparagraph pretty --includenumstat -rev -summary -authors=src/data/authors.xml-no-merges | git2cl > ChangeLog
cd po
svn2cl git log v{{version}}.. --pretty --numstat --reparagraph summary --includeno-rev merges --authors*.po | git2cl > 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/master/gramps/version.py gramps/version.py]</tt> to indicate an official release: 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/srcgen/dataconst.py]</authorstt> to indicate an official release: - VERSION += git_revision + #VERSION += git_revision Save change: git add .xml cd git commit -am "make official release" The version number should be the same on "about" dialog: python Gramps.pyor python Gramps.py -v ==Create a tag==Create the release tag: git tag -am "tag {{version}}" v{{version}} Tags should be prefixed with the letter v. ==Push to repository==Push the changes to the repository: git push origin v{{version}} ==Work on tag == ===Move to the new release number on branch =======Gramps 4.2.x====* 4.0.x Bump the version number in <tt>gramps/version.py</tt>
Using Update the <tt>Changelog</tt> files generated with <tt>svn2cl</tt> in version for the step above, edit and update the <tt>NEWS</tt> file.release:Commit the NEWS file. Note the svn commit revision numberVERSION_TUPLE = (4, 0, 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:Revert change on <tt>gramps/gen/gramps.svn.sourceforgeconst.netpy</svnroot/gramps/branches/maintenance/gramps{{stable_branch}} httpstt> to indicate git revision://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps -3.3.0 -m "tag 3.3.0"#VERSION += get_git_revision Committed revision 17752.+ VERSION += get_git_revision
==Working on the tag==Check out the new tagSave change: cd .. svn co https://gramps.svn.sourceforge.net/svnroot/gramps/tags/grampsgit commit -3.3.0am "bump to <new version number>" cd gramps-3.3.0git push
Modify ===Release from tag===  git checkout <tttag>configure.in-b </ttnew_branch_name> to indicate an official release: gedit configure.inThere are two changes to make::1) Change the following line: -RELEASE=0===Gramps 4.SVN$(svnversion -n 2.) +dnl RELEASEx==0.SVN$(svnversion -n .):2) And change this line: -dnl RELEASE=1 +RELEASE=1Save these two changes* Gramps-4. svn commit -m "make official release" configure0.inxNow run the following and check the version number in the "about" dialog: Modify <tt>MANIFEST.in</autogen.shtt> make+ include ChangeLog python src+ include po/gramps.pyChangeLog
==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 <tt>gramps-3.3.0.tar.gz</tt>, approximately 8 MB in size python setup.py sdist
==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==
* announce on Gramps blog
* 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.1 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]* update mantisdb(Bug/issue database) and enable the new version for reporting issues.
==Post-release==
* in <tt>gramps{{stable_branch}}</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]]