Jump to: navigation, search

What to do for a release

7,495 bytes added, 19:24, 27 July 2021
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 '''}}
=Updated guidelines for Git =
==Translation 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==Run this page first, to change the following numbers. But if you are only making an "alpha" or "beta" release, some steps: git checkout gramps{{Stable_branch}} git pull cd pomay be skipped, or altered slightly.
See Note also that [[Translation_environment4What_to_do_for_a_release#Post-release|New environmentPost release]] there are additional things which need to be done,which are related to making a new release, for instance making a new release-section here on the wiki, or making a new release-section on the bug tracker, or making new Debian and [[Talk:Translation_environment4|differences between tools]]Mac and Windows packages, so they will need to be coordinated with the appropriate people.
See also [ po/] to generate a new template/catalog (gramps.pot).) python3 -p git diff gramps.potrelease==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 ===Agree a release.timetable===
Co-ordinate with the [[Team#Package_Maintainers|package maintainers]] to agree a release timetable.For checking 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></code> if it contains translatable string constants and to <code>POTFILES.skip</code> if it does not.* Generate a new template file: python3 -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):
python3 -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==
* Check out the current stable branch:
git checkout maintenance/gramps{{Stable_branch}}
:That branch name assumes that you're using the same name as the Github repository; if you're not (perhaps you don't use <code>maintenance</code> in the name) use your local name.
* Make sure that your local copy is clean:
git status
: If you have any uncommitted changes, either commit them now or stash them until after you've completed the release.
* Clean up any untracked files and make sure that the local repo is up to date:
git clean -fdx
git pull --rebase
:If you had commits that hadn't been pushed yet they'll show up as "applying" messages in the output of this command. If that's the case re-run the tests and push as usual.
* Build and test to make sure that everything works, then clean the repo of all build products.
===Check the About box year===
Check if the year in the {{man label|About}} box needs to be updated
''© 2007-2020 The Gramps Developers''
''© 2007-'''2021''' The Gramps Developers''.
Found in <code>gramps/gen/</code>
===API docs update year===
If needed in the file:
Update the year for the copyright.
copyright = '2001-2019, The Gramps Project'
===Update Classifier in
Change [ Classifier] to the appropriate one in [] (master is always the first one)
Development Status :: 1 - Planning
Development Status :: 2 - Pre-Alpha
Development Status :: 3 - Alpha
Development Status :: 4 - Beta
Development Status :: 5 - Production/Stable
Check if any additional language classifier needs to be added also.
===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''' e.g.,
Found in
Please note that in Gramps master this key is always '''True'''.
See also {{bug|11274}}
==Release name==
Refer to (and update) the [[Previous releases of Gramps|list of previous releases]] . Previously you needed to select an appropriate namebut we have not named releases for several years now. You will still need to add the release though, including things like its relevant color. * [[Talk:Previous_releases_of_Gramps|Suggestions]] : For Gramps 5.0 <code>Just remember that you're standing on a planet that's evolving</code>
==Changelog and NEWS file==
Look at the changelog:
git log v{{version}}.. --pretty --numstat --summary --no-merges > ChangeLog
[ 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''.  Note that the <code>{{version}}</code> below means the ''previous'' version, not the one you're about to release (which is the<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*Edit and update the <ttcode>NEWS</ttcode> fileusing the new ChangeLog entries as a guide. If this is the first branch in a new series there will be no NEWS file, so look at a previous release and mimic the format.
Commit the NEWS file:
git add NEWS git commit -am m "update for {{version}} releaseUpdate Changelog and NEWS files"
==Working on VERSION==
* Check that the <code>VERSION_TUPLE</code> in <ttcode>[ gramps/]</ttcode> reflects the release you're about to indicate an official release: gedit gramps/  and It should if need, update the version for was bumped after the last release:. If not, fix it. VERSION_TUPLE = (4, 2, 0) * Modify <ttcode>[ gramps/gen/]</ttcode> to indicate an official release:
- VERSION += git_revision
+ #VERSION += git_revision
* Save changethe changes: git add . git commit -am "make official releaseRelease Gramps {{version}}"
The * Check that the version number should be the same on "about" dialogis correct: python3 Gramps.pyor
python3 -v
* If everything looks good, push the changes:
git push origin maintenance/gramps{{Stable_branch}}
* If that fails then someone pushed a commit while you were working. Return to [[What_to_do_for_a_release#Prepare_your_repository|Prepare your repository]] and start over.
==Create a tag==
Create the release tag; note the '''v''' leading the actual tag.: git tag -am "tag Tag {{version}}" v{{version}} Tags should be prefixed with the letter v.
==Push to repository==
Push the changes to the repository:
git push origin v{{version}}
==Work on tag ==
===Move to the new release number on branch ===
Bump the version number in <ttcode>gramps/</ttcode>
Update the version for the release:
VERSION_TUPLE = (4, 02, ...)
Revert change on <ttcode>gramps/gen/</ttcode> to indicate so that the git revisionis appended to the reported version in non-release builds:
- #VERSION += get_git_revision
+ VERSION += get_git_revision
Save change:
git commit -am "bump Bump to <new version number>"
git push
===Release from tag===
git checkout <tag> -b <new_branch_name>
git log v{{version}}.. --pretty --numstat --summary --no-merges | git2cl > ChangeLog
cd po
git log v{{version}}.. --pretty --numstat --summary --no-merges -- *.po | git2cl > ChangeLog
Using the <tt>Changelog</tt> files generated with <tt>git2cl</tt>,
Modify <tt></tt>
+ include ChangeLog
+ include po/ChangeLog
Create the official source tarball:
python3 sdist
==Making the source tarball available==
Create the <code>readme.rst</code> file containing the changes since the previous release.
* access the "Sourceforge Project Admin->File Manager" page at
or via your ''<dev>'' account:
$ sftp <dev>
Connecting to
sftp> cd /home/frs/project/gramps
* create a new folder in the "Stable" hierarchy
* upload the <tt>gramps-{{version}}.tar.gz</tt> file to the new folder
* Automatically created Github generates a tarball automatically when taggedwe push a tag.* Go to [ Github] and log in if necessary.* Select '''NN Releases''' from the line of items just above the thick line ('''NN''' is the number of releases so far).* 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.* Click '''Publish Release''' at the bottom of the edit area when you're satisfied with the contents.
===SourceForge===* Go to [https://githubsourceforge.comnet/projects/gramps-project/grampsfiles/releasesthe SourceForge files page] and log in if necessary.* 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 GitHub-generated tarball or create one locally: python3 sdist* Click '''Add File''' and drag the tarball to the drop area on the web page.* Copy the release notes from GitHub into a file called and upload it.
==Announcing the new release==
* 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 "[ Announcements]" category.* announce on Gramps [ blog] (File under: [ Gramps Releases] and [ 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)* change the topic update release date on the IRC channel #gramps[[Download]] page (not needed for an alpha or beta release)<code> /TOPIC #gramps Welcome to Gramps! The latest versions are {{version}} and * change the legacy 3.4.9 || || Please state OS Matrix room title and Gramps version when asking a question. Understand that replies can take up to 2 days depending on whose watching the IRC channel. Please consider asking on the gramps-users mailing list. </code>title (not needed for an alpha or beta release) * update the version number at [http Gramps_(software) Wikipedia]* update mantisdb(Bug/issue databasenot needed for an alpha or beta release) and enable the new version via Admin:Projects item for reporting issues.
* merge forward the <ttcode>NEWS</ttcode> file
=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 -->* [[Git|Brief introduction to Git]]
* [[Running a development version of Gramps]]
* [[:Category:Developers/Packaging]]
* [[GrampsAIO:Category:AppData]] - Screenshots used by Appdata -4 package updatingDebian* [[.dtd and .rng]]* [[Rollover_for_the_manual|Rollover for the Wiki]] - Updating 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 MS-Windows packageversion where the fix was applied. Remove links for fixed issues in Rollovers.
=External links=
* http** http

Navigation menu