Difference between revisions of "What to do for a release"
(update after a test for looking at changelog) |
m (→Making the source tarball available) |
||
(9 intermediate revisions by the same user not shown) | |||
Line 30: | Line 30: | ||
==Working on VERSION== | ==Working on VERSION== | ||
− | Modify <tt> | + | Modify <tt>version.py</tt> to indicate an official release: |
− | gedit | + | gedit gramps/version.py |
and update the version for the release: | and update the version for the release: | ||
− | + | VERSION_TUPLE = (4, 0, 0) | |
Save change. | Save change. | ||
− | svn commit -m "make official release" | + | svn commit -m "make official release" gramps/version.py |
The version number should be the same on "about" dialog: | The version number should be the same on "about" dialog: | ||
Line 43: | Line 43: | ||
==Subversion tag== | ==Subversion tag== | ||
Using the previous commit revision number, create a tag for the new release: | Using the previous commit revision number, create a tag for the new release: | ||
− | svn copy -r | + | svn copy -r 22385 https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps40 https://svn.code.sf.net/p/gramps/code/tags/gramps-4.0.0 -m "tag 4.0.0" |
− | Committed revision | + | Committed revision 22386. |
==Changelog and source tarball== | ==Changelog and source tarball== | ||
− | The Changelog files are required for the source tarball, but do not commit to subversion | + | The Changelog files are required for the source tarball, but do not commit them to subversion. |
− | + | ||
− | + | #Copy files from [[#Changelog and NEWS file|previous run under branch]]. | |
− | + | #Modify <tt>MANIFEST.in</tt> | |
− | + | + include ChangeLog | |
+ | |||
Create the official source tarball: | Create the official source tarball: | ||
python setup.py sdist | python setup.py sdist | ||
− | Note you should now have the file <tt>dist/gramps-4.0.0 | + | Note you should now have the file <tt>dist/gramps-4.0.0.tar.gz</tt>, approximately 14.7 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/ | * access the "Sourceforge Project Admin->File Manager" page at https://sourceforge.net/projects/gramps/ | ||
− | * create a new folder in the " | + | * create a new folder in the "Stable" hierarchy |
* upload the <tt>gramps-*.tar.gz</tt> file to the new folder | * upload the <tt>gramps-*.tar.gz</tt> file to the new folder | ||
Line 71: | Line 72: | ||
==Post-release== | ==Post-release== | ||
+ | * bump the version number in <tt>gramps/version.py</tt> | ||
* in <tt>trunk</tt>, merge forward the <tt>NEWS</tt> file | * in <tt>trunk</tt>, merge forward the <tt>NEWS</tt> file | ||
Revision as of 10:14, 24 June 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 version.py to indicate an official release:
gedit gramps/version.py
and update the version for the release:
VERSION_TUPLE = (4, 0, 0)
Save change.
svn commit -m "make official release" gramps/version.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 22385 https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps40 https://svn.code.sf.net/p/gramps/code/tags/gramps-4.0.0 -m "tag 4.0.0" Committed revision 22386.
Changelog and source tarball
The Changelog files are required for the source tarball, but do not commit them to subversion.
- Copy files from previous run under branch.
- Modify MANIFEST.in
+ include ChangeLog
Create the official source tarball:
python setup.py sdist
Note you should now have the file dist/gramps-4.0.0.tar.gz, approximately 14.7 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
- bump the version number in gramps/version.py
- 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