Difference between revisions of "What to do for a release"
m (→Gramps 3.4.x) |
m (→Making the source tarball available) |
||
(28 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | '''What to do for a release ''' | + | {{man note|Developer notes for '''What to do for a release '''}} |
=Updated guidelines for Git = | =Updated guidelines for Git = | ||
Line 8: | Line 8: | ||
cd po | cd po | ||
− | + | * Translations stuff | |
− | + | python3 update_po.py -p | |
− | |||
git diff gramps.pot | git 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. | 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. | ||
+ | |||
+ | For checking current translation files: | ||
+ | python3 update_po.py -k all | ||
==Release name== | ==Release name== | ||
Line 18: | Line 20: | ||
==Changelog and NEWS file== | ==Changelog and NEWS file== | ||
− | + | Look at the changelog: | |
− | git log | + | git log v{{version}}.. |
− | |||
− | |||
− | + | Edit and update the <tt>NEWS</tt> file. | |
Commit the NEWS file: | Commit the NEWS file: | ||
git commit -am "update for {{version}} release" | git commit -am "update for {{version}} release" | ||
==Working on VERSION== | ==Working on VERSION== | ||
− | |||
− | |||
− | |||
Check <tt>[https://github.com/gramps-project/gramps/blob/master/gramps/version.py gramps/version.py]</tt> to indicate an official release: | Check <tt>[https://github.com/gramps-project/gramps/blob/master/gramps/version.py gramps/version.py]</tt> to indicate an official release: | ||
Line 47: | Line 44: | ||
The version number should be the same on "about" dialog: | The version number should be the same on "about" dialog: | ||
− | + | python3 Gramps.py | |
or | or | ||
− | + | python3 Gramps.py -v | |
==Create a tag== | ==Create a tag== | ||
Line 64: | Line 61: | ||
===Move to the new release number on branch === | ===Move to the new release number on branch === | ||
− | |||
− | |||
Bump the version number in <tt>gramps/version.py</tt> | Bump the version number in <tt>gramps/version.py</tt> | ||
Line 73: | Line 68: | ||
Revert change on <tt>gramps/gen/const.py</tt> to indicate git revision: | Revert change on <tt>gramps/gen/const.py</tt> to indicate git revision: | ||
− | - #VERSION += get_git_revision | + | - #VERSION += get_git_revision |
− | + VERSION += get_git_revision | + | + VERSION += get_git_revision |
Save change: | Save change: | ||
Line 84: | Line 79: | ||
git checkout <tag> -b <new_branch_name> | git checkout <tag> -b <new_branch_name> | ||
− | + | git log v{{version}}.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog | |
− | * | + | git log v{{version}}.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog |
+ | |||
+ | Using the <tt>Changelog</tt> files generated with <tt>git2cl</tt>, | ||
Modify <tt>MANIFEST.in</tt> | Modify <tt>MANIFEST.in</tt> | ||
Line 93: | Line 90: | ||
Create the official source tarball: | Create the official source tarball: | ||
− | + | python3 setup.py sdist | |
− | ==== | + | ==Making the source tarball available== |
− | |||
− | + | Create the <code>readme.rst</code> file containing the changes since the previous release. | |
− | + | ===Github=== | |
− | + | * Automatically created when tagged | |
− | == | + | https://github.com/gramps-project/gramps/releases |
+ | |||
+ | ===Sourceforge=== | ||
* 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/ | ||
or via your ''<dev>'' account: | or via your ''<dev>'' account: | ||
Line 109: | Line 107: | ||
Connecting to frs.sourceforge.net... | Connecting to frs.sourceforge.net... | ||
Password: | Password: | ||
− | sftp> cd /home/frs/project/gramps | + | sftp> cd /home/frs/project/gramps/Stable |
* create a new folder in the "Stable" hierarchy | * create a new folder in the "Stable" hierarchy | ||
− | * | + | * put the <tt>readme.rst</tt> <tt>gramps-{{version}}.tar.gz</tt> files to the new folder |
==Announcing the new release== | ==Announcing the new release== | ||
Line 121: | Line 119: | ||
* update [[HeadlineNews]] | * update [[HeadlineNews]] | ||
* change the topic on the IRC channel #gramps | * change the topic on the IRC channel #gramps | ||
− | <code> /TOPIC #gramps Welcome to Gramps! The latest versions are | + | <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] | * update the version number at [http://en.wikipedia.org/wiki/Gramps Wikipedia] | ||
− | * update mantisdb(Bug/issue database) and enable the new version for reporting issues. | + | * update mantisdb(Bug/issue database) and enable the new version via Admin:Projects item for reporting issues. |
==Post-release== | ==Post-release== | ||
Line 132: | Line 130: | ||
* [[Running a development version of Gramps]] | * [[Running a development version of Gramps]] | ||
* [[:Category:Developers/Packaging]] | * [[:Category:Developers/Packaging]] | ||
+ | * [[GrampsAIO-4 package updating]] - Updating the MS-Windows package | ||
+ | * [[:Category:AppData]] - Screenshots used by Appdata - Debian | ||
=External links= | =External links= |
Revision as of 12:54, 5 September 2016
'Developer notes for What to do for a release ' |
Contents
Updated guidelines for Git
Translation update
Run the following steps:
git checkout gramps52 git pull cd po
- Translations stuff
python3 update_po.py -p git 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.
For checking current translation files:
python3 update_po.py -k all
Release name
Refer to (and update) the list of previous releases to select an appropriate name.
Changelog and NEWS file
Look at the changelog:
git log v5.2.2..
Edit and update the NEWS file. Commit the NEWS file:
git commit -am "update for 5.2.2 release"
Working on VERSION
Check gramps/version.py to indicate an official release:
gedit gramps/version.py
and if need, update the version for the release:
VERSION_TUPLE = (4, 2, 0)
Modify gramps/gen/const.py to indicate an official release:
- VERSION += git_revision + #VERSION += git_revision
Save change:
git add . git commit -am "make official release"
The version number should be the same on "about" dialog:
python3 Gramps.py
or
python3 Gramps.py -v
Create a tag
Create the release tag:
git tag -am "tag 5.2.2" v5.2.2
Tags should be prefixed with the letter v.
Push to repository
Push the changes to the repository:
git push origin v5.2.2
Work on tag
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, 0, ...)
Revert change on gramps/gen/const.py to indicate git revision:
- #VERSION += get_git_revision + VERSION += get_git_revision
Save change:
git commit -am "bump to <new version number>" git push
Release from tag
git checkout <tag> -b <new_branch_name>
git log v5.2.2.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog git log v5.2.2.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog
Using the Changelog files generated with git2cl,
Modify MANIFEST.in
+ include ChangeLog + include po/ChangeLog
Create the official source tarball:
python3 setup.py sdist
Making the source tarball available
Create the readme.rst
file containing the changes since the previous release.
Github
- Automatically created when tagged
https://github.com/gramps-project/gramps/releases
Sourceforge
- access the "Sourceforge Project Admin->File Manager" page at https://sourceforge.net/projects/gramps/
or via your <dev> account:
$ sftp <dev>@frs.sourceforge.net Connecting to frs.sourceforge.net... Password: sftp> cd /home/frs/project/gramps/Stable
- create a new folder in the "Stable" hierarchy
- put the readme.rst gramps-5.2.2.tar.gz files to the new folder
Announcing the new release
- announce on [email protected], [email protected] and [email protected]
- announce on Gramps blog
- update News section on this wiki
- update the list of previous releases
- update reference to the new version on the wiki template
- update HeadlineNews
- change the topic on the IRC channel #gramps
/TOPIC #gramps Welcome to Gramps! The latest versions are 5.2.2 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
- update mantisdb(Bug/issue database) and enable the new version via Admin:Projects item for reporting issues.
Post-release
- merge forward the NEWS file
See also
- Brief introduction to Git
- 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