Changes

Jump to: navigation, search

What to do for a release

2,131 bytes added, 19:24, 27 July 2021
m
Announcing the new release: Added compact list of Version templates where all the Values are also visible for inspection
{{man note|Developer notes for '''What to do for a release '''}}
Note that the main use of this page will be for makinga normal "minor" release. If you are making a "major"release (e.g. x.y.0) then you will need to update thispage first, to change the numbers. But if you are onlymaking an "alpha" or "beta" release, somesteps may be skipped, or altered slightly.
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 instancemaking a new release-section here on the wiki, ormaking a new release-section on the bug tracker, ormaking new Debian and Mac and Windows packages, sothey will need to be coordinated with the appropriatepeople.  ==Pre-release=====Agree a release timetable=== Co-ordinate with the [[Team#Package_Maintainers|package maintainers]] to agree a release timetable.For a major release there may be a schedule on the [[5.2_Roadmap|Roadmap]] ===Announce a feature freeze===For a major release, announce a feature freeze on the ''gramps-devel'' mailing list.This will usually be about 4 weeks before the release date. ===Translation update===The translation template should be updated, if necessary, just before the string freeze is announced.* 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" * Check current translation files (there must be no 'fatal' errors):people python3 update_po.py -k all  Also see:* [[Template:Gramps_translations#INCOMPLETE_TRANSLATIONS]] - Update if any translation needs to be added or excluded due to not meeting the minimum 70% completion requirement. ===Announce a string freeze===For a major release, announce a string freeze on the ''gramps-devel'' mailing list and on Weblate.This will usually be about 2 weeks before the release date.
==Prepare your repository==
eg:
''© 2007-2017 2020 The Gramps Developers''
to
''© 2007-'''20182021''' The Gramps Developers''.
Found in <code>gramps/gen/const.py</code>
If needed in the file:
gramps/docs/conf.py
Update the year for the copyright.
copyright = '2001-20182019, The Gramps Project'
===Update Classifier in setup.py===
Check if any additional language classifier needs to be added also.
==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"
* Check current translation files (there must be no ===Update the 'behavior.betawarn' key value=== If the release is '''Production/Stable''' make sure that the '''behavior.betawarn''' key value has been set to '''False''fatal' errors)e.g., https://github.com/gramps-project/gramps/commit/9dc976f28dc16c514e9e8e0b0fa09338bfe04f8a#diff-3d9e6dc03ea37a4b7f7975db17f16509 Found in gramps/gen/config.pyand python3 update_po gramps/gui/grampsgui.py -k all  Please note that in Gramps master this key is always '''True'''.
* if all is well, return to the root directory: cd ..See also {{bug|11274}}
==Release name==
<code>..</code>).
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
git add ChangeLog
git add po/ChangeLog
* 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 GithubGitHub-generated tarball or create one localllylocally:
python3 setup.py sdist
* Click '''Add File''' and drag the tarball to the drop area on the web page.
* 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 the Discourse forum in the "[https://gramps.discourse.group/c/gramps-announce Announcements]" category.* announce on Gramps [https://gramps-project.org/introduction-WPblog/blog/ blog] (File under: [https://gramps-project.org/introduction-WPblog/category/releases/ Gramps Releases] and [https://gramps-project.org/introduction-WPblog/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)
* Verify other [[:Category:Versions|"version" Wiki templates]] values: Last version, Stable version, etc.
* update [[HeadlineNews]] (not needed for an alpha or beta release)
* update release date on the [[Download]] page (not needed for an alpha or beta release)
* change the topic on the Matrix room title and IRC channel #gramps title (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 [httphttps://en.wikipedia.org/wiki/Gramps Gramps_(software) Wikipedia] (not needed for an alpha or beta release)
==Post-release==
=See also=
*Building a distribution to share as on the [[Download]] page
:[[File:Windows_32x32.png]] [[Building Gramps AIO cx freeze-based]] - Updating the MS-Windows 32-bit and 64-bit All-In-One packages
<!--
:[[File:Linux 32x32.png]] please add link to instructions on building Gramps installers for Linux. proofed while building v5.1.3
:[[File:Beastie 32x32.png]] please add link to instructions on building Gramps installer for BSD. proofed while building v5.1.3
:[[File:Apple logo black 32x32.png]] please add link to instructions on building Gramps installer for Apple. proofed while building v5.1.3
-->
* [[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
* [[.dtd and .rng]]
* [[Rollover_for_the_manual|Rollover for the Wiki]] - for major and minor releases. No rollover for maintenance releases.
* [[Special:WhatLinksHere/Template:Bug|List of pages linked to Bug Report template]] - verify the reported issues still apply to the new release. Leave links in place for any issue fixed in maintenance releases. Simply add notations for the version where the fix was applied. Remove links for fixed issues in Rollovers.
=External links=
3,015
edits

Navigation menu