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

From Gramps
Jump to: navigation, search
m (Include ChangeLog files)
m (point out section 2a of GPL)
(14 intermediate revisions by 2 users not shown)
Line 6: Line 6:
 
  git checkout gramps{{Stable_branch}}
 
  git checkout gramps{{Stable_branch}}
 
  git pull
 
  git pull
cd po
 
  
 
* Translations stuff
 
* Translations stuff
 +
cd po
 
  python3 update_po.py -p   
 
  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 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.
  
 
For checking current translation files:
 
For checking current translation files:
Line 23: Line 24:
 
  git log v{{version}}..
 
  git log v{{version}}..
  
Edit and update the <tt>NEWS</tt> file.
+
Edit and update the <code>NEWS</code> file.
 
Commit the NEWS file:
 
Commit the NEWS file:
 
  git commit -am "update for {{version}} release"
 
  git commit -am "update for {{version}} release"
Line 29: Line 30:
 
==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 <code>[https://github.com/gramps-project/gramps/blob/master/gramps/version.py gramps/version.py]</code> to indicate an official release:
 
  gedit gramps/version.py  
 
  gedit gramps/version.py  
  
Line 35: Line 36:
 
  VERSION_TUPLE = (4, 2, 0)
 
  VERSION_TUPLE = (4, 2, 0)
  
Modify <tt>[https://github.com/gramps-project/gramps/blob/master/gramps/gen/const.py#L132 gramps/gen/const.py]</tt> to indicate an official release:
+
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
 
  + #VERSION += git_revision
 
  + #VERSION += git_revision
Line 55: Line 56:
  
 
==Include ChangeLog files==
 
==Include ChangeLog files==
 +
 +
[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''.
  
 
  git checkout <tag>
 
  git checkout <tag>
Line 61: Line 64:
 
  git commit -am "Update ChangeLog files"
 
  git commit -am "Update ChangeLog files"
  
The <tt>Changelog</tt> files generated with <tt>git2cl</tt>.
+
The <code>Changelog</code> files generated with <code>git2cl</code>.
 +
 
 +
Will be also included on tarball generated by [[#Github|Github]].
  
 
==Push to repository==
 
==Push to repository==
Line 71: Line 76:
 
===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 <code>gramps/version.py</code>
  
 
Update the version for the release:
 
Update the version for the release:
 
  VERSION_TUPLE = (4, 0, ...)
 
  VERSION_TUPLE = (4, 0, ...)
  
Revert change on <tt>gramps/gen/const.py</tt> to indicate git revision:
+
Revert change on <code>gramps/gen/const.py</code> to indicate git revision:
 
  - #VERSION += get_git_revision
 
  - #VERSION += get_git_revision
 
  + VERSION += get_git_revision
 
  + VERSION += get_git_revision
Line 88: Line 93:
 
  git checkout <tag> -b <new_branch_name>
 
  git checkout <tag> -b <new_branch_name>
  
Modify <tt>MANIFEST.in</tt>
+
Modify <code>MANIFEST.in</code>
 
  + include ChangeLog
 
  + include ChangeLog
 
  + include po/ChangeLog
 
  + include po/ChangeLog
Line 105: Line 110:
 
https://github.com/gramps-project/gramps/releases
 
https://github.com/gramps-project/gramps/releases
  
===Sourceforge===
+
===Sourceforge (previous way)===
 
* 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 113: Line 118:
 
  sftp> cd /home/frs/project/gramps/Stable
 
  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
+
* put the <code>readme.rst</code> <code>gramps-{{version}}.tar.gz</code> files to the new folder
  
 
==Announcing the new release==
 
==Announcing the new release==
Line 128: Line 133:
  
 
==Post-release==
 
==Post-release==
* merge forward the <tt>NEWS</tt> file
+
* merge forward the <code>NEWS</code> file
  
 
=See also=
 
=See also=

Revision as of 07:51, 4 December 2016

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

Updated guidelines for Git

Translation update

Run the following steps:

git checkout gramps52
git pull
  • Translations stuff
cd po
python3 update_po.py -p  
git diff 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.

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.1..

Edit and update the NEWS file. Commit the NEWS file:

git commit -am "update for 5.2.1 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.1" v5.2.1

Tags should be prefixed with the letter v.

Include ChangeLog files

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.

git checkout <tag>
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 commit -am "Update ChangeLog files"

The Changelog files generated with git2cl.

Will be also included on tarball generated by Github.

Push to repository

Push the changes to the repository:

git push origin v5.2.1

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>

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 (previous way)

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.1.tar.gz files to the new folder

Announcing the new 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
  • 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

External links