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

From Gramps
Jump to: navigation, search
m (Guidelines for version 4.0)
m (Changelog and NEWS file)
 
(89 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
'''What to do for a release '''
 
'''What to do for a release '''
= Guidelines for version 4.0 =
+
=Updated guidelines for Git =
 
+
These notes are based on version 4.0.0alpha1, released in December 2012.  The steps assume a working <tt>gramps40</tt> source directory.
+
  
 
==Translation update==
 
==Translation update==
 
Run the following steps:
 
Run the following steps:
  cd gramps40
+
  git checkout gramps{{Stable_branch}}
  svn update
+
  git pull
 
  cd po
 
  cd po
  python update_po.py -p # or intltool-update -p , .genpot.sh see [[Translation_environment4|New environment]]
+
  ./genpot.sh # or python update_po.py -p see [[Translation_environment4|New environment]] and [[Talk:Translation_environment4|differences between tools]]
  svn diff gramps.pot
+
  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.
 
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==
 
==Release name==
Refer to (and update) the [[Previous releases|list of previous releases]] to select an appropriate name.
+
Refer to (and update) the [[Previous releases of Gramps|list of previous releases]] to select an appropriate name.
  
 
==Changelog and NEWS file==
 
==Changelog and NEWS file==
 
Create the changelog files:
 
Create the changelog files:
  svn2cl --reparagraph --include-rev --authors=gramps/data/authors.xml
+
  git log gramps-{{version}}.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
  cd po
+
  git log gramps-{{version}}.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog
svn2cl --reparagraph --include-rev --authors=../gramps/data/authors.xml
+
cd ..
+
  
Using the <tt>Changelog</tt> files generated with <tt>svn2cl</tt> in the step above, edit and update the <tt>NEWS</tt> file.
+
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.  Note the svn commit revision number, which you'll need in the next step when you create the subversion tag:
+
Commit the NEWS file:
  svn commit -m "update for 4.0.0-alpha1 release"
+
  git commit -am "update for {{version}} release"
Committed revision 20810.
+
  
 
==Working on VERSION==
 
==Working on VERSION==
  
Modify <tt>setup.py</tt> to indicate an official release:
+
* 4.0.x
gedit setup.py
+
and update the version for the release:
+
VERSION = "4.0.0-alpha1"
+
Save change.
+
svn commit -m "make official release" setup.py
+
The version number should be the same on "about" dialog:
+
python Gramps.py
+
  
==Subversion tag==
+
Check <tt>gramps/version.py</tt> to indicate an official release:
Using the previous commit revision number, create a tag for the new release:
+
  gedit gramps/version.py
  svn copy -r 20810 https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps40 https://svn.code.sf.net/p/gramps/code/tags/gramps-4.0.0-alpha1 -m "tag 4.0.0 alpha1"
+
Committed revision 20811.
+
  
==Changelog and source tarball==
+
and if need, update the version for the release:
The Changelog files are required for the source tarball, but do not commit to subversion:
+
  VERSION_TUPLE = (4, 0, 2)
  svn2cl --reparagraph --include-rev --authors=gramps/data/authors.xml
+
cd po
+
svn2cl --reparagraph --include-rev --authors=../gramps/data/authors.xml
+
cd ..
+
Create the official source tarball:
+
python setup.py sdist
+
  
Note you should now have the file <tt>dist/gramps-4.0.0-alpha1.tar.gz</tt>, approximately 12.2 Mo in size.
+
Modify <tt>gramps/gen/const.py</tt> to indicate an official release:
 +
- VERSION += get_git_revision(ROOT_DIR)
 +
+ VERSION += "-1"
  
==Making the source tarball available==
+
Save change:
* access the "Sourceforge Project Admin->File Manager" page at https://sourceforge.net/projects/gramps/
+
git commit -am "make official release"
* create a new folder in the "Unstable" hierarchy
+
* upload the <tt>gramps-*.tar.gz</tt> file to the new folder
+
  
==Announcing the new release==
+
The version number should be the same on "about" dialog:
* announce on gramps-announce@lists.sourceforge.net, gramps-devel@lists.sourceforge.net and gramps-users@lists.sourceforge.net
+
python Gramps.py
* update [[News]] section on this wiki
+
or
* update the list of [[previous releases]]
+
python Gramps.py -v
* update reference to the new version on the [[Template:Version|wiki template]]
+
* change the topic on the IRC channel #gramps
+
* update the version number at [http://en.wikipedia.org/wiki/GRAMPS Wikipedia]
+
  
==Post-release==
+
* 3.4.x
* in <tt>trunk</tt>, merge forward the <tt>NEWS</tt> file
+
 
+
= Guidelines for version 3.4 and before =
+
These notes are based on version 3.4.1, released in August 2012.  The steps assume a working <tt>gramps34</tt> source directory.
+
 
+
==Translation update==
+
Run the following steps:
+
cd gramps34
+
svn update
+
cd po
+
make gramps.pot
+
svn 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 releases|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 <tt>Changelog</tt> files generated with <tt>svn2cl</tt> in the step above, edit and update the <tt>NEWS</tt> 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.4.1 release"
+
Committed revision 20254.
+
 
+
==Subversion tag==
+
Using the previous commit revision number, create a tag for the new release:
+
svn copy -r 20254 https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps34 https://svn.code.sf.net/p/gramps/code/tags/gramps-3.4.1 -m "tag 3.4.1"
+
Committed revision 20255.
+
 
+
==Working on the tag==
+
Check out the new tag:
+
cd ..
+
svn co https://svn.code.sf.net/p/gramps/code/tags/gramps-3.4.1
+
cd gramps-3.4.1
+
  
 
Modify <tt>configure.in</tt> to indicate an official release:
 
Modify <tt>configure.in</tt> to indicate an official release:
Line 113: Line 51:
 
There are two changes to make:
 
There are two changes to make:
 
:1) Change the following line:
 
:1) Change the following line:
  -RELEASE=0.SVN$(svnversion -n .)
+
  -RELEASE=0.SVN$(git log -1 --format=%h .)
  +dnl RELEASE=0.SVN$(svnversion -n .)
+
  +dnl RELEASE=0.SVN$(git log -1 --format=%h .)
 
:2) And change this line:
 
:2) And change this line:
 
  -dnl RELEASE=1
 
  -dnl RELEASE=1
 
  +RELEASE=1
 
  +RELEASE=1
 
Save these two changes.
 
Save these two changes.
  svn commit -m "make official release" configure.in
+
  git commit -am "make official release" configure.in
 
Now run the following and check the version number in the "about" dialog:
 
Now run the following and check the version number in the "about" dialog:
 
  ./autogen.sh
 
  ./autogen.sh
make
 
 
  python src/gramps.py
 
  python src/gramps.py
  
==Changelog and source tarball==
+
==Create a tag==
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:
+
Create the release tag:
  svn2cl --reparagraph --include-rev --authors=src/data/authors.xml
+
  git tag -am "tag {{version}}" gramps-{{version}}
  cd po
+
 
  svn2cl --reparagraph --include-rev --authors=../src/data/authors.xml
+
==Push to repository==
  cd ..
+
Push the changes to the repository:
 +
  git push origin gramps-{{version}}
 +
 
 +
==Work on tag ==
 +
 
 +
===Move to the new release number on branch ===
 +
 
 +
* 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 += "-1"
 +
+ VERSION += get_git_revision(ROOT_DIR)
 +
 
 +
Save change:
 +
git commit -am "bump to <new version number>"
 +
git push
 +
 
 +
* 3.4.x
 +
 
 +
Bump the version number in <tt>configure.in</tt> and <tt>src/const.py.in</tt>
 +
 
 +
Save change:
 +
  git commit -am "bump to <new version number>"
 +
git push
 +
 
 +
===Release from tag===
 +
 
 +
git checkout <tag> -b <new_branch_name>
 +
 
 +
* Gramps-4.0.x
 +
 
 +
Modify <tt>MANIFEST.in</tt>
 +
+ include ChangeLog
 +
+ include po/ChangeLog
 +
 
 
Create the official source tarball:
 
Create the official source tarball:
make distcheck
 
  
Note you should now have the file <tt>gramps-3.4.1.tar.gz</tt>, approximately 9.6 Mo in size.
+
python setup.py sdist
 +
 
 +
* Gramps-3.4
 +
 
 +
Build, check and create the official source tarball:
 +
 
 +
./autogen.sh
 +
make distcheck
  
 
==Making the source tarball available==
 
==Making the source tarball available==
 
* access the "Sourceforge Project Admin->File Manager" page at https://sourceforge.net/projects/gramps/
 
* 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
 
* create a new folder in the "Stable" hierarchy
* upload the <tt>gramps-*.tar.gz</tt> file to the new folder
+
* upload the <tt>gramps-{{version}}.tar.gz</tt> file to the new folder
  
 
==Announcing the new release==
 
==Announcing the new release==
 
* announce on gramps-announce@lists.sourceforge.net, gramps-devel@lists.sourceforge.net and gramps-users@lists.sourceforge.net
 
* 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 [[News]] section on this wiki
* update the list of [[previous releases]]
+
* update the list of [[Previous releases of Gramps|previous releases]]
 
* update reference to the new version on the [[Template:Version|wiki template]]
 
* update reference to the new version on the [[Template:Version|wiki template]]
 +
* update [[HeadlineNews]]
 
* change the topic on the IRC channel #gramps
 
* change the topic on the IRC channel #gramps
* update the version number at [http://en.wikipedia.org/wiki/GRAMPS Wikipedia]
+
<pre> /TOPIC #gramps Welcome to Gramps! The latest versions are 4.1.0 and the legacy 3.4.8 || 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. </pre>
 +
* update the version number at [http://en.wikipedia.org/wiki/Gramps Wikipedia]
  
 
==Post-release==
 
==Post-release==
* in <tt>gramps34</tt>, bump the version number in <tt>configure.in</tt> and <tt>src/const.py.in</tt>
+
* merge forward the <tt>NEWS</tt> file
* in <tt>trunk</tt>, merge forward the <tt>NEWS</tt> file
+
  
 
=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]]
 
* [[:Category:Developers/Packaging]]

Latest revision as of 09:08, 27 February 2015

What to do for a release

Updated guidelines for Git

Translation update

Run the following steps:

git checkout gramps4.1


git pull
cd po
./genpot.sh # or python update_po.py -p  see New environment and differences between tools
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.2.0.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
git log gramps-4.2.0.. --pretty --numstat --summary --no-merges -- po/*.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.2.0 release"

Working on VERSION

  • 4.0.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, 0, 2)

Modify gramps/gen/const.py to indicate an official release:

- VERSION += get_git_revision(ROOT_DIR)
+ VERSION += "-1"

Save change:

git commit -am "make official release"

The version number should be the same on "about" dialog:

python Gramps.py

or

python Gramps.py -v
  • 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$(git log -1 --format=%h .)
+dnl RELEASE=0.SVN$(git log -1 --format=%h .)
2) And change this line:
-dnl RELEASE=1
+RELEASE=1

Save these two changes.

git commit -am "make official release" configure.in

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

./autogen.sh
python src/gramps.py

Create a tag

Create the release tag:

git tag -am "tag 4.2.0" gramps-4.2.0

Push to repository

Push the changes to the repository:

git push origin gramps-4.2.0

Work on tag

Move to the new release number on branch

  • 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 += "-1"
+ VERSION += get_git_revision(ROOT_DIR)

Save change:

git commit -am "bump to <new version number>"
git push
  • 3.4.x

Bump the version number in configure.in and src/const.py.in

Save change:

git commit -am "bump to <new version number>"
git push

Release from tag

git checkout <tag> -b <new_branch_name>
  • Gramps-4.0.x

Modify MANIFEST.in

+ include ChangeLog
+ include po/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

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

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
  • update HeadlineNews
  • change the topic on the IRC channel #gramps
 /TOPIC #gramps Welcome to Gramps! The latest versions are 4.1.0 and the legacy 3.4.8 || 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. 

Post-release

  • merge forward the NEWS file

See also

External links