Open main menu

Gramps β

Changes

What to do for a release

7,754 bytes added, 7 April
→‎Github
{{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 thatthere are additional things which need to be done,necessary [[What_to_do_for_a_release#Post-release|Post release]] tasks which are related to making a new release. For instance, for instancethe wiki will require making a new release-section here on and updating [[Template:Version_Templates#General|"General" version templates]]. For the wiki, ormaking a new release-section on the bug tracker. Or when making new Debian and Mac and Windows [[:Category:Developers/Packaging|packaging]], sothey will need to be coordinated with the appropriatepeople. Probably there should be a section of thispage which lists things like that[[Team#Package_Maintainers|package maintainers]] and updating the corresponding [[:Category:Versions|Versions]] : [[Template:Version_Templates|Templates]].
=Updated guidelines for Git =Pre-release=====Agree a release timetable===
==Translation update==Co-ordinate with the [[Team#Package_Maintainers|package maintainers]] to agree a release timetable.Run For a major release there may be a schedule on the following steps: git checkout gramps{{Stable_branch}} git pull[[5.2_Roadmap|Roadmap]]
* Translations stuff===Announce a feature freeze=== cd po python3 update_poFor a major release, announce a feature freeze on the ''gramps-devel'' mailing list.py -p git diff grampsThis will usually be about 4 weeks before the release date.pot
===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 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.
==Release name=Announce a string freeze===Refer 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. 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==* 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 update) test to make sure that everything works, then clean the [[Previous releases repo of all build products. ===Check the About box year=== Check if the year in the {{man label|About}} box needs to be updated eg: ''© 2007-2023 The Gramps|list of previous releases]] Developers'' to select an appropriate name ''© 2007-'''2024''' The Gramps Developers''. Found in <code>gramps/gen/const.py</code> ===API docs update year===If needed in the file:
==Changelog and NEWS file==Look at the changelog: git log v{{version}}.docs/conf.py
Edit and update the <code>NEWS</code> file.
Commit the NEWS file:
git commit -am "update for {{version}} release"
==Working on VERSION==Update the year for the copyright.
Check <code>[https://github.com/gramps copyright = '2001-project/gramps/blob/master/gramps/version.py gramps/version.py]</code> to indicate an official release: gedit gramps/version.py 2024, The Gramps Project'
and if need, update the version for ===Update Classifier in setup.py===Change [https://pypi.python.org/pypi?%3Aaction=list_classifiers Classifier] to the releaseappropriate one in [https://github.com/gramps-project/gramps/blob/maintenance/gramps50/setup.py setup.py] VERSION_TUPLE = (4, 2, 0master is always the first one)
Modify <codepre>[httpsDevelopment Status :: 1 - PlanningDevelopment Status :: 2 - Pre-AlphaDevelopment Status :: 3 - AlphaDevelopment Status :: 4 - BetaDevelopment Status ://github.com/gramps: 5 -projectProduction/gramps/blob/master/gramps/gen/const.py#L132 gramps/gen/const.py]Stable</codepre> to indicate an official release: - VERSION += git_revision + #VERSION += git_revision
Save change: git commit -am "make official release"Check if any additional language classifier needs to be added also.
The version number should be ==Release name==Refer to (and update) the same on "about" dialog: python3 Gramps.pyor python3 [[Previous releases of Gramps|list of previous releases]].py -v
==Create a tag==Create Previously you needed to select an appropriate name but we have not named releases for several years now. You will still need to add the release tag: git tag -am "tag {{version}}" v{{version}}though, including things like its relevant color.
Tags should be prefixed with the letter v* [[Talk:Previous_releases_of_Gramps|Suggestions]] : For Gramps 5.0 <code>Just remember that you're standing on a planet that's evolving</code>
==Include ChangeLog filesChangelog and NEWS file==
[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 Note that the <tagcode>{{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 <code>NEWS</code> file using 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 ChangeLog Changelog and NEWS files" ==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> reflects the release you're about to make. It should if the version was bumped after the last release. If not, fix it. * Add an entry to the [https://github.com/gramps-project/gramps/blob/maintenance/gramps52/data/org.gramps_project.Gramps.metainfo.xml.in org.gramps_project.Gramps.metainfo.xml.in] file. * Save the changes: git pushcommit -am "Release Gramps {{version}}" * Check that the version number is correct: python3 Gramps.py -v
The <code>Changelog<* If everything looks good, push the changes: git push origin maintenance/code> files generated with <code>git2cl</code>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.
Should be included on tarball generated by [[#Github|Github]]==Create a tag==Create the release tag; note the '''v''' leading the actual tag.: git tag -am "Tag {{version}}" v{{version}}
==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 ===
VERSION_TUPLE = (4, 2, ...)
Revert change on <code>gramps/gen/const.pyDEV_VERSION</code> to indicate so that the git revisionis appended to the reported version in non-release builds: - #VERSION +DEV_VERSION = get_git_revisionFalse + VERSION +DEV_VERSION = get_git_revisionTrue
Save change:
git commit -am "bump Bump to <new version number>"
git push
===Release from tagGithub===* Github generates a tarball automatically when we push a tag.* Go to [https://github.com/gramps-project/gramps 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.* Add the sh256sum of the source distribution to the bottom of the release notes.
git checkout <tag> -b <new_branch_name>You can obtain the sha256sum with the following command:
git archive --format=tar --prefix=Making the source tarball available== The source tarball is generated by github in relation with the created tag. ===Github===* Automatically created when taggedgramps-{{version}} v{{version}} | gzip | sha256sum
httpsAlternatively, download it and use://github.com/gramps-project/gramps/releases
Previous way for creating the official source tarball: sha256sum gramps-{{version}}.tar.gz
python3 setup* Click '''Publish Release''' at the bottom of the edit area when you're satisfied with the contents.py sdist
===SourceForge===* Edit Go to [https://sourceforge.net/projects/gramps/files/ the tag SourceForge files page] and publish 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 setup.py sdist* Click '''Add File''' and drag the tarball to the drop area on the web page.* Copy the releasenotes from GitHub into a file called README.md 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 "[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)* 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 || http://www.gramps-project.org/ || 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 [httphttps://en.wikipedia.org/wiki/Gramps 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.
==Post-release==
=See also=
* Category [[Git: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<!--:[[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=
* https://github.com/gramps-project
* httphttps://gramps-project.org/cpanel* http://svn.code.sf.net/p/gramps/code/* httphttps://sourceforge.net/projects/gramps/
[[Category:Developers/General]]
[[Category:Developers/Packaging]]
Retrieved from "https://www.gramps-project.org/wiki/index.php/Special:MobileDiff/64577...103689"