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

From Gramps
Jump to: navigation, search
m (Why ChangeLog files?)
m (Include ChangeLog files)
(6 intermediate revisions by the same user not shown)
Line 57: Line 57:
 
==Include ChangeLog files==
 
==Include ChangeLog files==
  
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''.  
+
[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 63: Line 63:
 
  git log v{{version}}.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog
 
  git log v{{version}}.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog
 
  git commit -am "Update ChangeLog files"
 
  git commit -am "Update ChangeLog files"
 +
git push
  
 
The <code>Changelog</code> files generated with <code>git2cl</code>.
 
The <code>Changelog</code> files generated with <code>git2cl</code>.
  
Will be also included on tarball generated by [[#Github|Github]].
+
Should be included on tarball generated by [[#Github|Github]].
  
 
==Push to repository==
 
==Push to repository==

Revision as of 16:38, 21 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"
git push

The Changelog files generated with git2cl.

Should be 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