Difference between revisions of "What to do for a release"

From Gramps
Jump to: navigation, search
m (minor cleanup)
m (Gramps 4.2.x)
(161 intermediate revisions by 8 users not shown)
Line 1: Line 1:
'''What to do for a release'''
+
'''What to do for a release '''
 +
=Updated guidelines for Git =
  
These notes are based on a 2.2.x-based release.  Specifically, these are the notes that resulted from the release of 2.2.9 in October 2007:
+
==Translation update==
 +
Run the following steps:
 +
git checkout gramps{{Stable_branch}}
 +
git pull
 +
cd po
  
==Translations==
+
===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 
 +
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.
  
* announce the intent to release on the <tt>[email protected]</tt> mailing list; ask that no further changes be committed to svn
+
==Release name==
* build what should be the final <tt>gramps.pot</tt> file:
+
Refer to (and update) the [[Previous releases of Gramps|list of previous releases]] to select an appropriate name.
 +
 
 +
==Changelog and NEWS file==
 +
Create the changelog files:
 +
git log v{{version}}.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
 
  cd po
 
  cd po
  make gramps.pot
+
  git log v{{version}}.. --pretty --numstat --summary --no-merges -- *.po | git2cl > ChangeLog
* commit the new <tt>gramps.pot</tt> file to svn
+
 
* ask for all [[Translating GRAMPS|translators]] on <tt>gramps-users@lists.sourceforge.net</tt> and <tt>gramps-devel@lists.sourceforge.net</tt> to update the <tt>.po</tt> files; plan to release about 1 to 2 weeks after this date
+
Using the <tt>Changelog</tt> files generated with <tt>git2cl</tt> in the step above, edit and update the <tt>NEWS</tt> file.
* ask for translators to e-mail their <tt>.po</tt> files to you; not all translators have svn access; expect to spend a bit of time checking in <tt>.po</tt> files
+
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/gen/const.py]</tt> 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:
 +
python Gramps.py
 +
or
 +
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>
 +
 
 +
Update the version for the release:
 +
VERSION_TUPLE = (4, 0, ...)
 +
 
 +
Revert change on <tt>gramps/gen/const.py</tt> 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>
  
==Preparing the tarball==
+
====Gramps 4.2.x====
 +
* Gramps-4.0.x
  
* edit <tt>ChangeLog</tt>
+
Modify <tt>MANIFEST.in</tt>
* edit <tt>NEWS</tt> to add a few lines
+
  + include ChangeLog
* edit <tt>configure.in</tt>; change the following lines:
+
  + include po/ChangeLog
  RELEASE=0.SVN$(svnversion -n .)
 
dnl RELEASE=1
 
:to instead say:
 
dnl RELEASE=0.SVN$(svnversion -n .)
 
  RELEASE=1
 
* run the following command:
 
make distcheck
 
* note that you should now have the <tt>gramps-2.2.x.tar.gz</tt> file
 
  
==Making the candidate build available==
+
Create the official source tarball:
  
* login to cpanel at http://gramps-project.org/cpanel
+
python setup.py sdist
* upload the candidate <tt>.tar.gz</tt> file into the <tt>public_html/test/</tt> directory
 
* ask people to download and test from http://gramps-project.org/test/
 
  
==Making the release available==
+
==Making the source tarball available==
* note the names of [[previous releases]]
+
* access the "Sourceforge Project Admin->File Manager" page at https://sourceforge.net/projects/gramps/
* upload the tarball by anonymous ftp to ftp://upload.sourceforge.net/incoming/
+
or via your ''<dev>'' account:
* access the Sourceforge "admin" tab at http://sourceforge.net/projects/gramps/
+
$ sftp <dev>@frs.sourceforge.net
* go to "File Releases"
+
Connecting to frs.sourceforge.net...
* add a new release in the "Stable" package
+
Password:
* fill in name: a number such as 2.2.8 is the name for sourceforge site
+
sftp> cd /home/frs/project/gramps
* enter release notes -- usually this is the new section of the NEWS file
+
* create a new folder in the "Stable" hierarchy
* add uploaded file(s) to the release by checking the appropriate check button and then clicking the "Add Files and/or Refresh View" button
+
* upload the <tt>gramps-{{version}}.tar.gz</tt> file to the new folder
* set architecture and the file type, click "Update/Refresh"
 
  
==Once the release is available==
+
==Announcing the new release==
* announce on <tt>[email protected]</tt>, <tt>[email protected]</tt> and <tt>[email protected]</tt>
+
* update news section on this wiki
+
* announce on Gramps blog
* update reference to the new version on the [[Installation]] page
+
* 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 Wikipedia]
 +
* update mantisdb(Bug/issue database) and enable the new version for reporting issues.
  
==Update the version number==
+
==Post-release==
* edit <tt>configure.in</tt>; increment the version number
+
* merge forward the <tt>NEWS</tt> file
* make certain the <tt>RELEASE=1</tt> line is back to <tt>dnl RELEASE=1</tt>
 
* commit to svn
 
  
==See also==
+
=See also=
* [[Brief introduction to SVN]]
+
* [[Git|Brief introduction to Git]]
 
* [[Running a development version of Gramps]]
 
* [[Running a development version of Gramps]]
 +
* [[:Category:Developers/Packaging]]
  
==External links==
+
=External links=
* http://gramps.svn.sourceforge.net/viewvc/gramps/
+
* https://github.com/gramps-project
 
* http://gramps-project.org/cpanel
 
* http://gramps-project.org/cpanel
 +
* http://svn.code.sf.net/p/gramps/code/
 
* http://sourceforge.net/projects/gramps/
 
* http://sourceforge.net/projects/gramps/
  
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]

Revision as of 17:00, 6 January 2016

What to do for a release

Updated guidelines for Git

Translation update

Run the following steps:

git checkout gramps52
git pull
cd po

Gramps 4.x

For Gramps 4.x use (See New environment and differences between tools. See po/update_po.py to generate a new template/catalog (gramps.pot).)

python update_po.py -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.

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 v5.2.1.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
cd po
git log v5.2.1.. --pretty --numstat --summary --no-merges -- *.po | git2cl > 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 5.2.1 release"

Working on VERSION

Gramps 4.2.x

  • 4.2.x

Check gramps/version.py to indicate an official release:

gedit gramps/version.py 

and if need, update the version for the release:

VERSION_TUPLE = (4, 2, 0)

Modify gramps/gen/const.py 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:

python Gramps.py

or

python Gramps.py -v

Create a tag

Create the release tag:

git tag -am "tag 5.2.1" v5.2.1

Tags should be prefixed with the letter v.

Push to repository

Push the changes to the repository:

git push origin v5.2.1

Work on tag

Move to the new release number on branch

Gramps 4.2.x

  • 4.0.x

Bump the version number in gramps/version.py

Update the version for the release:

VERSION_TUPLE = (4, 0, ...)

Revert change on gramps/gen/const.py 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>

Gramps 4.2.x

  • Gramps-4.0.x

Modify MANIFEST.in

+ include ChangeLog
+ include po/ChangeLog

Create the official source tarball:

python setup.py sdist

Making the source tarball available

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 gramps-5.2.1.tar.gz file to the new folder

Announcing the new release

/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.

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

Post-release

  • merge forward the NEWS file

See also

External links