915
edits
Changes
→Github
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 there are additional necessary [[What_to_do_for_a_release#Post-release|Post release]] there are additional things which need to be done,tasks which are related to making a new release. For instance, for instance the wiki will require making a new release-section here on and updating [[Template:Version_Templates#General|"General" version templates]]. For the wiki, or making a new release-section on the bug tracker, or . Or when making new Debian and Mac and Windows packages[[:Category:Developers/Packaging|packaging]], so they will need to be coordinated with the appropriate people[[Team#Package_Maintainers|package maintainers]] and updating the corresponding [[:Category:Versions|Versions]] : [[Template:Version_Templates|Templates]].
==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===
This will usually be about 4 weeks before the release date.
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 restore 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):
python3 update_po.py -k all
:There should be very few warnings or fatal errors. Warnings related to new languages using default values in their headers are acceptable. There will also be some fatal errors reported due to the non-standard way we handle inflected dates. See the section on [https://gramps-project.org/wiki/index.php/Date_Handler#Localizing_the_date_formats Localizing the date formats] in the [https://gramps-project.org/wiki/index.php/Date_Handler Date Handler] wiki page for further details. For example "{long_month}" may be translated as "{long_month.f[Р]}".:All other fatal errors should be fixed.
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===
This will usually be about 2 weeks before the release date.
In the ''Program'' component on Weblate, select "Manage⟶Post announcement" from the menu. Enter an ''Expiry date'' the day before the release date, and select the ''Notify users'' checkbox to send a notification to all subscribed users.
==Prepare your repository==
eg:
''© 2007-2018 2023 The Gramps Developers''
to
''© 2007-'''20192024''' The Gramps Developers''.
Found in <code>gramps/gen/const.py</code>
Update the year for the copyright.
copyright = '2001-20192024, The Gramps Project'
===Update Classifier in setup.py===
Check if any additional language classifier needs to be added also.
==Release name==
==Working on VERSION==
* Modify <code>[https://github.com/gramps-project/gramps/blob/master/gramps/version.py gramps/version.py]</code> to indicate an official release:
- DEV_VERSION = True
+ DEV_VERSION = False
* 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>Add an entry to the [https://github.com/gramps-project/gramps/blob/mastermaintenance/grampsgramps52/gendata/constorg.gramps_project.Gramps.metainfo.xml.in org.py#L132 gramps/gen/constgramps_project.Gramps.metainfo.xml.pyin]</code> to indicate an official release: - VERSION += git_revision + #VERSION += git_revisionfile.
* Save the changes:
VERSION_TUPLE = (4, 2, ...)
Revert change on <code>gramps/gen/const.pyDEV_VERSION</code> so that the git revision is appended to the reported version in non-release builds: - #VERSION +DEV_VERSION = get_git_revisionFalse + VERSION +DEV_VERSION = get_git_revisionTrue
Save change:
* Find the tag you just pushed and click it, or click the "Draft a new release" button.
* Copy the NEWS file contents into the '''Write''' tab. You can use the '''Preview''' tab to check your formatting.
* Add the sh256sum of the source distribution to the bottom of the release notes.
You can obtain the sha256sum with the following command:
git archive --format=tar --prefix=gramps-{{version}} v{{version}} | gzip | sha256sum
Alternatively, download it and use:
sha256sum gramps-{{version}}.tar.gz
* Click '''Publish Release''' at the bottom of the edit area when you're satisfied with the contents.
* 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/blog/blog/ blog] (File under: [https://gramps-project.org/blog/category/releases/ Gramps Releases] and [https://gramps-project.org/blog/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)
* have the IRC channel admin ([[Template:Reviews/ReviewList#General|tosky]]) 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 version is {{version}} || https://www.gramps-project.org/</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=
*Category [[:Category:Versions|Versions]] : [[Template:Version_Templates|Template]]
*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
* [[: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=
[[Category:Developers/General]]
[[Category:Developers/Packaging]]