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

From Gramps
Jump to: navigation, search
(When the candidate is ready to be released)
(See also)
(235 intermediate revisions by 10 users not shown)
Line 1: Line 1:
'''What to do for a release'''
+
{{man note|Developer notes for '''What to do for a release '''}}
  
These notes are based on a 2.2.x-based releaseSpecifically, these are the notes that resulted from the release of 2.2.9 in October 2007:
+
Note that the main use of this page will be for making
 +
a normal "minor" release.  If you are making a "major"
 +
release (e.g. x.y.0) then you will need to update this
 +
page first, to change the numbersBut if you are only
 +
making an "alpha" or "beta" release, some
 +
steps may be skipped, or altered slightly.
  
==Translations==
+
Note also that [[What_to_do_for_a_release#Post-release|Post release]]
 +
there are additional things which need to be done,
 +
which are related to making a new release, for instance
 +
making a new release-section here on the wiki, or
 +
making a new release-section on the bug tracker, or
 +
making new Debian and Mac and Windows packages, so
 +
they will need to be coordinated with the appropriate
 +
people.
  
* announce the intent to release on the gramps[email protected] mailing list; ask that no further changes be committed to svn
+
==Prepare your repository==
* build what should be the last <tt>gramps.pot</tt> file:
+
* Check out the current stable branch:
cd po
+
  git checkout maintenance/gramps{{Stable_branch}}
make gramps.pot
+
:That branch name assumes that you're using the same name as the Github repository; if you're not (perhaps you don't use <code>maintenance</code> in the name) use your local name.
* commit the new <tt>gramps.pot</tt> file to svn
+
* Make sure that your local copy is clean:
* ask for all [[Translating GRAMPS|translators]] on gramps-users@lists.sourceforge.net and gramps-[email protected] to update the <tt>.po</tt> files; plan to release about 1 to 2 weeks after this date
+
  git status
* ask for translators to e-mail their <tt>.po</tt> files to you; not all translators have svn access; expect to spend a bit of time checking in <tt>.po</tt> files
+
: If you have any uncommitted changes, either commit them now or stash them until after you've completed the release.
 +
* Clean up any untracked files and make sure that the local repo is up to date:
 +
  git clean -fdx
 +
  git pull --rebase
 +
:If you had commits that hadn't been pushed yet they'll show up as "applying" messages in the output of this command. If that's the case re-run the tests and push as usual.
 +
* Build and test to make sure that everything works, then clean the repo of all build products.
  
==Preparing the tarball==
+
==Translation update==
 +
* Check for new files since the last release:
 +
  cd po
 +
  intltool-update -m
 +
:That will create a file called <code>missing</code>in the <code>po</code> directory if there are new files that need to be scanned for translatable strings. Examine each of the files listed in <code>missing</code>, adding each to <code>POTFILES.in</code> if it contains translatable string constants and to <code>POTFILES.skip</code> if it does not.
 +
* Generate a new template file:
 +
  python3 update_po.py -p # makes a new gramps.pot template file
 +
  git diff gramps.pot
 +
:Examine the changes. If they're all just comments about where a string is found you need not commit the change (so the next line will restore the official file, instead of the one you just made):
 +
  git checkout gramps.pot
 +
:If there have been changes on <code>msgid</code> entries, you'll need to commit <code>gramps.pot</code> and ask translators to update their <tt>.po</tt> files before you can make a release:
 +
  git add gramps.pot
 +
  git commit -m "Update translation template for new release."
  
* edit <tt>ChangeLog</tt>
+
* Check current translation files (there must be no 'fatal' errors):
* edit <tt>NEWS</tt> to add a few lines
+
  python3 update_po.py -k all
* edit <tt>configure.in</tt>; change the following lines:
 
RELEASE=0.SVN$(svnversion -n .)
 
dnl RELEASE=1
 
:to instead say:
 
dnl RELEASE=0.SVN$(svnversion -n .)
 
RELEASE=1
 
* run the following command:
 
make distcheck
 
* note that you should now have the <tt>gramps-2.2.x.tar.gz</tt> file
 
  
==Making the candidate build available==
+
* if all is well, return to the root directory:
 +
  cd ..
  
* login to cpanel at http://gramps-project.org/cpanel
+
==Release name==
* upload the candidate <tt>.tar.gz</tt> file into the <tt>public_html/test/</tt> directory
+
Refer to (and update) the [[Previous releases of Gramps|list of previous releases]]. Previously you needed to select an appropriate name but we have not named releases for several years now. You will
* ask people to download and test from http://gramps-project.org/test/
+
still need to add the release though, including things like its
 +
relevant color.
  
==Releasing the source tarball on SourceForge==
+
==Changelog and NEWS file==
* note the names of [[previous releases]]
 
* upload the tarball by anonymous ftp to ftp://upload.sourceforge.net/incoming/
 
* 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: a number such as 2.2.8 is the name for sourceforge site
 
* enter release notes -- usually this is the new section of the NEWS file
 
* 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 the file type, click "Update/Refresh"
 
* send notifications to the sourceforge subscribers of gramps
 
  
==Following the tarball release==
+
[https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html#section2 Section ''2a''] of the '''G'''eneral '''P'''ublic '''L'''icense says that if you distribute a modified version of a program: ''you must cause the modified files to carry prominent notices stating that you changed the files and the date of any change''.
* announce on gramps-announce@lists.sourceforge.net, as well as devel and user list
 
* update news section on this wiki
 
* change reference from old to new version on the [[Installation]] page
 
  
==Update the version number==
+
Note that the <code>{{version}}</code> below means the ''previous'' version, not the one you're about to release (which is the
* edit <tt>configure.in</tt>; increment the version number
+
<code>..</code>).
* make certain the <tt>RELEASE=1</tt> line is back to <tt>dnl RELEASE=1</tt>
+
git log v{{version}}.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
* commit to svn
+
git log v{{version}}.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog
 +
git add ChangeLog
 +
*Edit and update the <code>NEWS</code> file using the new ChangeLog entries as a guide. If this is the first branch in a new series there will be no NEWS file, so look at a previous release and mimic the format.
 +
Commit the NEWS file:
 +
git add NEWS
 +
git commit -m "Update NEWS for {{version}} release"
  
==See also==
+
==Working on VERSION==
* [[Brief introduction to SVN]]
+
 
 +
* Check that the <code>VERSION_TUPLE</code> in <code>[https://github.com/gramps-project/gramps/blob/master/gramps/version.py gramps/version.py]</code>reflects the release you're about to make. It should if the version was bumped after the last release. If not, fix it.
 +
 +
* Modify <code>[https://github.com/gramps-project/gramps/blob/master/gramps/gen/const.py#L132 gramps/gen/const.py]</code> to indicate an official release:
 +
- VERSION += git_revision
 +
+ #VERSION += git_revision
 +
 
 +
* Save the changes:
 +
git commit -am "Release Gramps {{version}}"
 +
 
 +
* Check that the version number is correct:
 +
python3 Gramps.py -v
 +
 
 +
* If everything looks good, push the changes:
 +
  git push origin maintenance/gramps{{Stable_branch}}
 +
* If that fails then someone pushed a commit while you were working. Return to [https://gramps-project.org/wiki/index.php?title=What_to_do_for_a_release#Prepare_your_repository Prepare your repository] and start over.
 +
 
 +
==Create a tag==
 +
Create the release tag; note the '''v''' leading the actual tag.:
 +
git tag -am "Tag {{version}}" v{{version}}
 +
 
 +
==Push to repository==
 +
Push the changes to the repository:
 +
git push origin v{{version}}
 +
 
 +
===Move to the new release number on branch ===
 +
 
 +
Bump the version number in <code>gramps/version.py</code>
 +
 
 +
Update the version for the release:
 +
VERSION_TUPLE = (4, 2, ...)
 +
 
 +
Revert change on <code>gramps/gen/const.py</code> so that the git revision is appended to the reported version in non-release builds:
 +
- #VERSION += get_git_revision
 +
+ VERSION += get_git_revision
 +
 
 +
Save change:
 +
git commit -am "bump to <new version number>"
 +
git push
 +
 
 +
===Github===
 +
* Github generates a tarball automatically when we push a tag.
 +
* Go to [https://github.com/gramps-project/gramps Github] and log in if necessary.
 +
* Select '''NN Releases''' from the line of items just above the thick line ('''NN''' is the number of releases so far).
 +
* Find the tag you just pushed and click Edit.
 +
* Copy the NEWS file contents into the '''Write''' tab. You can use the '''Preview''' tab to check your formatting.
 +
* Click '''Publish Release''' at the bottom of the edit area when you're satisfied with the contents.
 +
 
 +
===SourceForge===
 +
* Go to [https://sourceforge.net/projects/gramps/files/ the SourceForge files page] and log in if necessary.
 +
* Click on '''Stable''' or '''Unstable''' depending on the class of the release you're making.
 +
* Click '''Add Folder''' and name the directory for the release version. Click "'Create'". Click your new folder to enter it.
 +
* You can either download the Github-generated tarball or create one locallly:
 +
  python3 setup.py sdist
 +
* Click '''Add File''' and drag the tarball to the drop area on the web page.
 +
 
 +
==Announcing the new release==
 +
* update mantisdb(Bug/issue database) and enable the new version via Admin:Projects item for reporting issues. (You will need a high-enough status on the bug tracker in order to do this, so you can ask an appropriate person if you aren't.)
 +
* announce on [email protected], [email protected] and [email protected] (You will need to be a member of all three lists first, to send to them.)
 +
* announce on Gramps [https://gramps-project.org/introduction-WP/blog/ blog] (File under: [https://gramps-project.org/introduction-WP/category/releases/ Gramps Releases] and [https://gramps-project.org/introduction-WP/category/news/  News]) (not needed for an alpha or beta release)
 +
* update [[News]] section on this wiki (not needed for an alpha or beta release)
 +
* update the list of [[Previous releases of Gramps|previous releases]]
 +
* update reference to the new version on the [[Template:Version|wiki template]] (not needed for an alpha or beta release)
 +
* update [[HeadlineNews]] (not needed for an alpha or beta release)
 +
* change the topic on the IRC channel #gramps (not needed for an alpha or beta release)
 +
<code> /TOPIC #gramps Welcome to Gramps! The latest versions are {{version}} and the legacy 3.4.9 || 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. </code>
 +
* update the version number at [http://en.wikipedia.org/wiki/Gramps Wikipedia] (not needed for an alpha or beta release)
 +
 
 +
==Post-release==
 +
* merge forward the <code>NEWS</code> file
 +
 
 +
=See also=
 +
* [[Brief introduction to Git]]
 
* [[Running a development version of Gramps]]
 
* [[Running a development version of Gramps]]
 +
* [[:Category:Developers/Packaging]]
 +
* [[GrampsAIO-4 package updating]] - Updating the MS-Windows package
 +
* [[:Category:AppData]] - Screenshots used by Appdata - Debian
  
==External links==
+
=External links=
* http://gramps.svn.sourceforge.net/viewvc/gramps/
+
* https://github.com/gramps-project
 
* 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 23:34, 13 January 2018

Gramps-notes.png
'Developer notes for What to do for a release '

Note that the main use of this page will be for making a normal "minor" release. If you are making a "major" release (e.g. x.y.0) then you will need to update this page first, to change the numbers. But if you are only making an "alpha" or "beta" release, some steps may be skipped, or altered slightly.

Note also that Post release there are additional things which need to be done, which are related to making a new release, for instance making a new release-section here on the wiki, or making a new release-section on the bug tracker, or making new Debian and Mac and Windows packages, so they will need to be coordinated with the appropriate people.

Prepare your repository

  • Check out the current stable branch:
 git checkout maintenance/gramps52
That branch name assumes that you're using the same name as the Github repository; if you're not (perhaps you don't use maintenance in the name) use your local name.
  • Make sure that your local copy is clean:
 git status
If you have any uncommitted changes, either commit them now or stash them until after you've completed the release.
  • Clean up any untracked files and make sure that the local repo is up to date:
 git clean -fdx
 git pull --rebase
If you had commits that hadn't been pushed yet they'll show up as "applying" messages in the output of this command. If that's the case re-run the tests and push as usual.
  • Build and test to make sure that everything works, then clean the repo of all build products.

Translation update

  • Check for new files since the last release:
 cd po
 intltool-update -m 
That will create a file called missingin the po directory if there are new files that need to be scanned for translatable strings. Examine each of the files listed in missing, adding each to POTFILES.in if it contains translatable string constants and to POTFILES.skip if it does not.
  • Generate a new template file:
 python3 update_po.py -p # makes a new gramps.pot template file
 git diff gramps.pot
Examine the changes. If they're all just comments about where a string is found you need not commit the change (so the next line will restore the official file, instead of the one you just made):
 git checkout gramps.pot
If there have been changes on msgid entries, you'll need to commit gramps.pot and ask translators to update their .po files before you can make a release:
 git add gramps.pot
 git commit -m "Update translation template for new release."
  • Check current translation files (there must be no 'fatal' errors):
 python3 update_po.py -k all
  • if all is well, return to the root directory:
 cd ..

Release name

Refer to (and update) the list of previous releases. Previously you needed to select an appropriate name but we have not named releases for several years now. You will still need to add the release though, including things like its relevant color.

Changelog and NEWS file

Section 2a of the General Public License says that if you distribute a modified version of a program: you must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

Note that the 5.2.1 below means the previous version, not the one you're about to release (which is the ..).

git log v5.2.1.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
git log v5.2.1.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog
git add ChangeLog 
  • Edit and update the NEWS file using the new ChangeLog entries as a guide. If this is the first branch in a new series there will be no NEWS file, so look at a previous release and mimic the format.

Commit the NEWS file:

git add NEWS
git commit -m "Update NEWS for 5.2.1 release"

Working on VERSION

  • Check that the VERSION_TUPLE in gramps/version.pyreflects the release you're about to make. It should if the version was bumped after the last release. If not, fix it.
- VERSION += git_revision
+ #VERSION += git_revision
  • Save the changes:
git commit -am "Release Gramps 5.2.1"
  • Check that the version number is correct:
python3 Gramps.py -v
  • If everything looks good, push the changes:
 git push origin maintenance/gramps52
  • If that fails then someone pushed a commit while you were working. Return to Prepare your repository and start over.

Create a tag

Create the release tag; note the v leading the actual tag.:

git tag -am "Tag 5.2.1" v5.2.1

Push to repository

Push the changes to the repository:

git push origin v5.2.1

Move to the new release number on branch

Bump the version number in gramps/version.py

Update the version for the release:

VERSION_TUPLE = (4, 2, ...)

Revert change on gramps/gen/const.py so that the git revision is appended to the reported version in non-release builds:

- #VERSION += get_git_revision
+ VERSION += get_git_revision

Save change:

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

Github

  • Github generates a tarball automatically when we push a tag.
  • Go to Github and log in if necessary.
  • Select NN Releases from the line of items just above the thick line (NN is the number of releases so far).
  • Find the tag you just pushed and click Edit.
  • Copy the NEWS file contents into the Write tab. You can use the Preview tab to check your formatting.
  • Click Publish Release at the bottom of the edit area when you're satisfied with the contents.

SourceForge

  • Go to the SourceForge files page and log in if necessary.
  • Click on Stable or Unstable depending on the class of the release you're making.
  • Click Add Folder and name the directory for the release version. Click "'Create'". Click your new folder to enter it.
  • You can either download the Github-generated tarball or create one locallly:
 python3 setup.py sdist
  • Click Add File and drag the tarball to the drop area on the web page.

Announcing the new release

  • update mantisdb(Bug/issue database) and enable the new version via Admin:Projects item for reporting issues. (You will need a high-enough status on the bug tracker in order to do this, so you can ask an appropriate person if you aren't.)
  • announce on [email protected], [email protected] and [email protected] (You will need to be a member of all three lists first, to send to them.)
  • announce on Gramps blog (File under: Gramps Releases and News) (not needed for an alpha or beta release)
  • update News section on this wiki (not needed for an alpha or beta release)
  • update the list of previous releases
  • update reference to the new version on the wiki template (not needed for an alpha or beta release)
  • update HeadlineNews (not needed for an alpha or beta release)
  • change the topic on the IRC channel #gramps (not needed for an alpha or beta release)

/TOPIC #gramps Welcome to Gramps! The latest versions are 5.2.1 and the legacy 3.4.9 || 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.

  • update the version number at Wikipedia (not needed for an alpha or beta release)

Post-release

  • merge forward the NEWS file

See also

External links