{{man note|Developer notes for '''What to do for a release'''}}

These notes Note that the main use of this page will be for making a normal "minor" release. If you are based on making a 2"major" release (e.2g.x-based release.y.0) then you will need to update this page first, to change the numbers. Specifically, these But if you are the notes that resulted from the only making an "alpha" or "beta" release of 2.2, some steps may be skipped, or altered slightly.9 in October 2007:

* announce the intent to release on the [email protected] mailing list; ask that no further changes be committed to svn* build what should be the last <tt>gramps.pot</tt> file: cd po make gramps.pot* commit the new <tt>gramps.pot</tt> file to svn* ask for all [[Translating GRAMPS|translators]] on gramps==Pre-[email protected] and [email protected] to update the <tt>.po</tt> files; plan to release about 1 to 2 weeks after this date==* ask for translators to e-mail their <tt>.po</tt> files to you; not all translators have svn access; expect to spend ===Agree a bit of time checking in <tt>.po</tt> filesrelease timetable===

==Preparing Co-ordinate with the tarball==[[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]]

* edit <tt>ChangeLog</tt>* edit <tt>NEWS</tt> to add ===Announce a few lines* edit <tt>configure.in</tt>; change the following lines: RELEASEfeature freeze=0.SVN$(svnversion -n .) dnl RELEASE=1:to instead say: dnl RELEASE=0.SVN$(svnversion -n .) RELEASE=1* run the following command: make distcheck* note that you should now have For a major release, announce a feature freeze on the <tt>''gramps-2devel'' mailing list.2.x.tarThis will usually be about 4 weeks before the release date.gz</tt> file

==Making the candidate build available=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"

* login Check current translation files: python3 update_po.py -k all:There should be very few warnings or fatal errors. Warnings related to cpanel at httpnew 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/cpanel* upload the candidate <tt>wiki/index.tar.gz<php/tt> file into Date_Handler#Localizing_the_date_formats Localizing the <tt>public_html/test/</tt> directory* ask people to download and test from httpdate formats] in the [https://gramps-project.org/testwiki/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.

==Make releasing on SourceForge site=Announce a string freeze===* note the names of [[previous releases]]* upload the tarball by anonymous ftp to ftp://upload.sourceforge.net/incoming/* access the Sourceforge "admin" tab at http://sourceforge.net/projects/gramps/* go to "File Releases"* add For a new major release in , announce a string freeze on the "Stable" package* fill in name: a number such as 2.2''gramps-devel'' mailing list and on Weblate.8 is the name for sourceforge site* enter release notes -- This will usually this is the new section of the NEWS file* add uploaded file(s) to be about 2 weeks before the release by checking the appropriate check button and then clicking the "Add Files and/or Refresh View" button* set architecture and the file type, click "Update/Refresh"* send notifications to the sourceforge subscribers of grampsdate.

==Following In the tarball release==* announce ''Program'' component on gramps-announce@listsWeblate, select "Manage⟶Post announcement" from the menu.sourceforge.net Enter an ''Expiry date'' the day before the release date, as well as devel and user list* update news section on this wiki* change reference from old select the ''Notify users'' checkbox to send a notification to new version on the [[Installation]] pageall subscribed users.

==Update the version numberPrepare your repository==* edit 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 <ttcode>configure.inmaintenance</ttcode>; increment 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 version numberrelease.* Clean up any untracked files and make certain sure that the <tt>RELEASE=1</tt> line local repo is back up to <tt>dnl RELEASE=1</tt>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.* commit Build and test to svnmake 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 eg: ''© 2007-2023 The Gramps Developers'' to ''© 2007-'''2024''' The Gramps Developers''. Found in <code>gramps/gen/const.py</code> ===API docs update year===If needed in the file: docs/conf.py  Update the year for the copyright.  copyright = '2001-2024, The Gramps Project' ===Update Classifier in setup.py===Change [https://pypi.python.org/pypi?%3Aaction=list_classifiers Classifier] to the appropriate one in [https://github.com/gramps-project/gramps/blob/maintenance/gramps50/setup.py setup.py] (master is always the first one) <pre>Development Status :: 1 - PlanningDevelopment Status :: 2 - Pre-AlphaDevelopment Status :: 3 - AlphaDevelopment Status :: 4 - BetaDevelopment Status :: 5 - Production/Stable</pre> Check if any additional language classifier needs to be added also. ==Release name==Refer to (and update) the [[Previous releases of Gramps|list of previous releases]]. 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 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== [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''.  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 <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 -m "Update 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 commit -am "Release Gramps {{version}}" * Check that the version number is correct: python3 Gramps.py -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 {{version}}" v{{version}} ==Push to repository==Push the changes to the repository: git push origin v{{version}} ===Move to the new release number on branch === Bump the version number in <code>gramps/version.py</code> Update the version for the release: VERSION_TUPLE = (4, 2, ...) Revert change on <code>DEV_VERSION</code> so that the git revision is appended to the reported version in non-release builds: - DEV_VERSION = False + DEV_VERSION = True Save change: git commit -am "Bump to <new version number>" git push ===Github===* 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. 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. ===SourceForge===* Go to [https://sourceforge.net/projects/gramps/files/ the 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 setup.py 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 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/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)* change the Matrix room title and IRC channel title (not needed for an alpha or beta release) * update the version number at [https://en.wikipedia.org/wiki/Gramps_(software) Wikipedia] (not needed for an alpha or beta release) ==Post-release==* merge forward the <code>NEWS</code> file =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<!--:[[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 SVNGit]]

==External links==* httphttps://grampsgithub.svn.sourceforge.net/viewvccom/gramps/-project* httphttps://gramps-project.org/cpanel* httphttps://sourceforge.net/projects/gramps/