Difference between revisions of "What to do for a release"
m (→Making the release available: uploads now go to frs.sourceforge.net) |
(re-write of the entire page based on my notes from GRAMPS 3.0.3) |
||
Line 1: | Line 1: | ||
'''What to do for a release''' | '''What to do for a release''' | ||
− | These notes are based on | + | These notes are based on version 3.0.3, released in October 2008. The steps assume a working <tt>gramps30</tt> source directory. See [[Running a development version of Gramps]] if this is not the case. |
− | == | + | ==Translation update== |
− | + | Run the following steps: | |
− | + | cd gramps30 | |
− | + | svn update | |
cd po | cd po | ||
make gramps.pot | 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 | svn2cl --reparagraph --include-rev --authors=src/data/authors.xml | ||
cd po | cd po | ||
svn2cl --reparagraph --include-rev --authors=../src/data/authors.xml | svn2cl --reparagraph --include-rev --authors=../src/data/authors.xml | ||
cd .. | 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.0.3 release" | ||
+ | Committed revision 11159. | ||
+ | |||
+ | ==Subversion tag== | ||
+ | Create a tag for the release: | ||
+ | svn copy -r 11159 https://gramps.svn.sourceforge.net/svnroot/gramps/branches/gramps30 https://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.0.3 -m "tag 3.0.3" | ||
+ | |||
+ | ==Working on the tag== | ||
+ | Check out the new tag: | ||
+ | cd .. | ||
+ | svn co https://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.0.3 | ||
+ | cd gramps-3.0.3 | ||
− | + | Modify <tt>configure.in</tt> 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 | make distcheck | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | == | + | Note you should now have the file <tt>gramps-3.0.3.tar.gz</tt>, approximately 5.5 MB in size. |
− | * | + | |
+ | ==Making the source tarball available== | ||
+ | Run the following steps: | ||
+ | sftp [email protected] | ||
+ | cd uploads | ||
+ | put gramps-3.0.3.tar.gz | ||
+ | * access the Sourceforge <tt>admin</tt> tab at http://sourceforge.net/projects/gramps/ | ||
+ | * go to <tt>File Releases</tt> | ||
+ | * add a new release in the <tt>Stable</tt> package | ||
+ | * fill in name, e.g., <tt>3.0.3</tt> | ||
+ | * enter release notes (usually this is the text from <tt>NEWS</tt>) | ||
+ | * add uploaded file(s) to the release by checking the appropriate check button and then clicking the "<tt>Add Files and/or Refresh View</tt>" button | ||
+ | * set architecture and file type, click "<tt>Update/Refresh</tt>" | ||
+ | |||
+ | ==Announcing the new release== | ||
+ | |||
* 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 [[installation|installation page]] |
− | * change the topic on the IRC channel | + | * 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== |
− | * | + | * in <tt>gramps30</tt>, bump the version number in <tt>configure.in</tt> |
− | * | + | * in <tt>trunk</tt>, merge forward the <tt>NEWS</tt> file |
− | |||
==See also== | ==See also== |
Revision as of 04:36, 20 October 2008
What to do for a release
These notes are based on version 3.0.3, released in October 2008. The steps assume a working gramps30 source directory. See Running a development version of Gramps if this is not the case.
Contents
Translation update
Run the following steps:
cd gramps30 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.0.3 release" Committed revision 11159.
Subversion tag
Create a tag for the release:
svn copy -r 11159 https://gramps.svn.sourceforge.net/svnroot/gramps/branches/gramps30 https://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.0.3 -m "tag 3.0.3"
Working on the tag
Check out the new tag:
cd .. svn co https://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.0.3 cd gramps-3.0.3
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.0.3.tar.gz, approximately 5.5 MB in size.
Making the source tarball available
Run the following steps:
sftp [email protected] cd uploads put gramps-3.0.3.tar.gz
- access the Sourceforge admin tab at http://sourceforge.net/projects/gramps/
- go to File Releases
- add a new release in the Stable package
- fill in name, e.g., 3.0.3
- enter release notes (usually this is the text from NEWS)
- add uploaded file(s) to the release by checking the appropriate check button and then clicking the "Add Files and/or Refresh View" button
- set architecture and file type, click "Update/Refresh"
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 installation page
- change the topic on the IRC channel #gramps
- update the version number at Wikipedia
Post-release
- in gramps30, bump the version number in configure.in
- in trunk, merge forward the NEWS file