Difference between revisions of "What to do for a release"
m (→Post-release: also const.py.in) |
m (→Changelog and NEWS file) |
||
(26 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 = | ||
− | These notes are based on version | + | 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 | + | cd gramps40 |
+ | svn update | ||
+ | cd po | ||
+ | python update_po.py -p # or intltool-update -p , .genpot.sh see [[Translation_environment4|New environment]] | ||
+ | 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=../data/authors.xml | ||
+ | cd po | ||
+ | svn2cl --reparagraph --include-rev --authors=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 4.0.0-alpha1 release" | ||
+ | Committed revision 20810. | ||
+ | |||
+ | ==Working on VERSION== | ||
+ | |||
+ | Modify <tt>setup.py</tt> to indicate an official release: | ||
+ | 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== | ||
+ | Using the previous commit revision number, create a tag for the new release: | ||
+ | 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== | ||
+ | The Changelog files are required for the source tarball, but do not commit to subversion: | ||
+ | svn2cl --reparagraph --include-rev --authors=../data/authors.xml | ||
+ | cd po | ||
+ | svn2cl --reparagraph --include-rev --authors=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. | ||
+ | |||
+ | ==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 "Unstable" hierarchy | ||
+ | * upload the <tt>gramps-*.tar.gz</tt> file to the new folder | ||
+ | |||
+ | ==Announcing the new release== | ||
+ | |||
+ | * update [[News]] section on this wiki | ||
+ | * update the list of [[previous releases]] | ||
+ | * 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== | ||
+ | * 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 | svn update | ||
cd po | cd po | ||
Line 24: | Line 97: | ||
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>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: | 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. | + | svn commit -m "update for 3.4.1 release" |
− | Committed revision | + | Committed revision 20254. |
==Subversion tag== | ==Subversion tag== | ||
− | + | Using the previous commit revision number, create a tag for the new release: | |
− | svn copy -r | + | 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== | ==Working on the tag== | ||
Check out the new tag: | Check out the new tag: | ||
cd .. | cd .. | ||
− | svn co https:// | + | svn co https://svn.code.sf.net/p/gramps/code/tags/gramps-3.4.1 |
− | cd gramps-3. | + | 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 62: | Line 136: | ||
make distcheck | make distcheck | ||
− | Note you should now have the file <tt>gramps-3. | + | Note you should now have the file <tt>gramps-3.4.1.tar.gz</tt>, approximately 9.6 Mo in size. |
==Making the source tarball available== | ==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 <tt>gramps-*.tar.gz</tt> file to the new folder | |
− | |||
− | * access the Sourceforge | ||
− | * | ||
− | |||
− | * | ||
− | |||
− | |||
− | |||
==Announcing the new release== | ==Announcing the new release== | ||
Line 81: | Line 147: | ||
* update [[News]] section on this wiki | * update [[News]] section on this wiki | ||
* update the list of [[previous releases]] | * update the list of [[previous releases]] | ||
− | * update reference to the new version on the [[ | + | * update reference to the new version on the [[Template:Version|wiki template]] |
* 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] | * update the version number at [http://en.wikipedia.org/wiki/GRAMPS Wikipedia] | ||
==Post-release== | ==Post-release== | ||
− | * in <tt> | + | * 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 | * in <tt>trunk</tt>, merge forward the <tt>NEWS</tt> file | ||
− | + | =See also= | |
* [[Brief introduction to SVN]] | * [[Brief introduction to SVN]] | ||
* [[Running a development version of Gramps]] | * [[Running a development version of Gramps]] | ||
* [[:Category:Developers/Packaging]] | * [[:Category:Developers/Packaging]] | ||
− | + | =External links= | |
− | * http:// | + | * http://svn.code.sf.net/p/gramps/code/ |
* http://gramps-project.org/cpanel | * http://gramps-project.org/cpanel | ||
* http://sourceforge.net/projects/gramps/ | * http://sourceforge.net/projects/gramps/ | ||
[[Category:Developers/General]] | [[Category:Developers/General]] |
Revision as of 06:43, 27 January 2013
What to do for a release
Contents
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 setup.py to indicate an official release:
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
Using the previous commit revision number, create a tag for the new release:
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
The Changelog files are required for the source tarball, but do not commit to subversion:
svn2cl --reparagraph --include-rev --authors=../data/authors.xml cd po svn2cl --reparagraph --include-rev --authors=data/authors.xml cd ..
Create the official source tarball:
python setup.py sdist
Note you should now have the file dist/gramps-4.0.0-alpha1.tar.gz, approximately 12.2 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 "Unstable" 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
Post-release
- in trunk, merge forward the NEWS 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 gramps34 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 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=src/data/authors.xml cd po svn2cl --reparagraph --include-rev --authors=../src/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 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 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
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 gramps-3.4.1.tar.gz, approximately 9.6 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
Post-release
- in gramps34, bump the version number in configure.in and src/const.py.in
- in trunk, merge forward the NEWS file