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

From Gramps
Jump to: navigation, search
(re-write of the entire page based on my notes from GRAMPS 3.0.3)
m (→‎External links)
(20 intermediate revisions by 5 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 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.
+
'''TODO'''
 +
 
 +
= 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==
 
==Translation update==
 
Run the following steps:
 
Run the following steps:
−
  cd gramps30
+
  cd gramps34
 
  svn update
 
  svn update
 
  cd po
 
  cd po
Line 24: Line 28:
 
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.0.3 release"
+
  svn commit -m "update for 3.4.1 release"
−
  Committed revision 11159.
+
  Committed revision 20254.
  
 
==Subversion tag==
 
==Subversion tag==
−
Create a tag for the release:
+
Using the previous commit revision number, create a tag for the new 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"
+
  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://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.0.3
+
  svn co https://svn.code.sf.net/p/gramps/code/tags/gramps-3.4.1
−
  cd gramps-3.0.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 67:
 
  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.
+
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==
−
Run the following steps:
+
* access the "Sourceforge Project Admin->File Manager" page at https://sourceforge.net/projects/gramps/
−+
* create a new folder in the "Stable" hierarchy
−
cd uploads
+
* upload the <tt>gramps-*.tar.gz</tt> file to the new folder
−
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==
 
==Announcing the new release==
Line 81: Line 78:
 
* 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 [[installation|installation page]]
+
* 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>gramps30</tt>, bump the version number in <tt>configure.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
  
Line 95: Line 92:
  
 
==External links==
 
==External links==
−
* http://gramps.svn.sourceforge.net/viewvc/gramps/
+
* 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 12:41, 26 October 2012

What to do for a release

Guidelines for version 4.0

TODO

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

Announcing the new release

Post-release

  • in gramps34, bump the version number in configure.in and src/const.py.in
  • in trunk, merge forward the NEWS file

See also

External links

Retrieved from "https://gramps-project.org/wiki/index.php?title=What_to_do_for_a_release&oldid=40121"