Changes

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

These notes Note that the main use of this page will be for makinga normal "minor" release. If you are based on version 3making a "major"release (e.g. x.3y.0) then you will need to update thispage first, released in June 2011to change the numbers. The But if you are onlymaking an "alpha" or "beta" release, somesteps assume may be skipped, or altered slightly. Note also thatthere 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 working new release-section on the bug tracker, ormaking new Debian and Mac and Windows packages, sothey will need to be coordinated with the appropriatepeople. Probably there should be a section of thispage which lists things like that ("Post-release" maybe?). ==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 <ttcode>gramps33maintenance</ttcode> source directoryin 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. See [[Running a development version * 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 Gramps]] if this is not command. If that's the casere-run the tests and push as usual.* Build and test to make sure that everything works, then clean the repo of all build products.

Run * Check for new files since the following stepslast release: cd gramps33po svn intltool-update-m cd :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. make * Generate a new template file: python3 update_po.py -p # makes a new gramps.pottemplate file svn 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 changeson <code>msgid</code> entries, you'll need to commit <ttcode>gramps.pot</ttcode> 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 * if all is well, return to the root directory: cd ..

Refer to (and update) the [[Previous releasesof Gramps|list of previous releases]] . Previously you needed to select an appropriate namebut we have not named releases for several years now. You willstill need to add the release though, including things like itsrelevant color.

Using [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 <ttcode>Changelog{{version}}</ttcode> files generated with below means the ''previous'' version, not the one you're about to release (which is the<ttcode>svn2cl..</ttcode>). git log v{{version}}.. --pretty --numstat --summary --no-merges | git2cl > in the step above, edit ChangeLog git log v{{version}}.. --pretty --numstat --summary --no-merges -- po/*.po | git2cl > po/ChangeLog git add 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 -m "Update NEWS for {{version}} release" ==Working on VERSION== * 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. Note * Modify <code>[https://github.com/gramps-project/gramps/blob/master/gramps/gen/const.py#L132 gramps/gen/const.py]</code> to indicate an official release: - VERSION += git_revision + #VERSION += git_revision * Save the svn changes: git commit revision -am "Release Gramps {{version}}" * Check that the version numberis correct: python3 Gramps.py -v * If everything looks good, which push the changes: git push origin maintenance/gramps{{Stable_branch}}* If that fails then someone pushed a commit while youwere working. Return to [https://gramps-project.org/wiki/index.php?title=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'''ll need in leading the next step when you create the subversion actual tag.: svn commit git tag -m am "update for 3.3.0 releaseTag {{version}}"v{{version}} ==Push to repository==Push the changes to the repository: Committed revision 17751.git push origin v{{version}} ===Move to the new release number on branch ===

==Subversion tag==Using Bump the previous commit revision version number, create a tag for the new release: svn copy -r 17751 https://in <code>gramps.svn.sourceforge.net/svnroot/gramps/branches/maintenance/gramps33 https://gramps.svn.sourceforgeversion.netpy</svnroot/gramps/tags/gramps-3.3.0 -m "tag 3.3.0" Committed revision 17752.code>

==Working on Update the tag==Check out version for the new tagrelease: cd .VERSION_TUPLE = (4, 2, . svn co https://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.3.0 cd gramps-3.3.0)

Modify Revert change on <ttcode>configuregramps/gen/const.inpy</ttcode> so that the git revision is appended to indicate an official the reported version in non-release: gedit configure.inThere are two changes to make::1) Change the following linebuilds: -RELEASE#VERSION +=0.SVN$(svnversion -n .)get_git_revision +dnl RELEASE=0.SVN$(svnversion -n .):2) And change this line: -dnl RELEASE=1 VERSION +RELEASE=1Save these two changes. svn commit -m "make official release" configure.inNow run the following and check the version number in the "about" dialog: ./autogen.sh make python src/gramps.pyget_git_revision

==Changelog and source tarball==Save change:Re-create (or copy from above) the 2 Changelog files. The Changelog files are required for the source tarball, but do not git commit -am "bump to subversion: svn2cl --reparagraph --include-rev --authors=src/data/authors.xml cd po svn2cl --reparagraph --include-rev --authors=../src/data/authors.xml cd ..Create the official source tarball:<new version number>" make distcheckgit push

Note you should now have the file <tt>===Github===* Github generates a tarball automatically when we push a tag.* Go to [https://github.com/gramps-3project/gramps Github] and log in if necessary.3* Select '''NN Releases''' from the line of items just above the thick line ('''NN''' is the number of releases so far).0* Find the tag you just pushed and click Edit.tar* Copy the NEWS file contents into the '''Write''' tab.gz</tt>, approximately 8 MB in sizeYou 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.

==Making the source tarball available=SourceForge===* access the "Sourceforge Project Admin->File Manager" page at Go to [https://sourceforge.net/projects/gramps/files/ the SourceForge files page] and log in if necessary.* create a new folder in 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 "Stable'Create'" hierarchy. Click your new folder to enter it.* upload You can either download the <tt>grampsGithub-generated tarball or create one locallly: python3 setup.py sdist*.tar.gz</tt> file Click '''Add File''' and drag the tarball to the new folderdrop 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 Gramps [https://gramps-project.org/introduction-WP/blog/ blog] (File under: [https://gramps-project.org/introduction-WP/category/releases/ Gramps Releases] and [https://gramps-project.org/introduction-WP/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)* update [[HeadlineNews]] (not needed for an alpha or beta release)* change the topic on the IRC channel #gramps(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 [http://en.wikipedia.org/wiki/GRAMPS Gramps Wikipedia](not needed for an alpha or beta release)

* in <tt>gramps33</tt>, bump the version number in <tt>configure.in</tt> and <tt>src/const.py.in</tt>* in <tt>trunk</tt>, merge forward the <ttcode>NEWS</ttcode> file

==See also==* [[Git|Brief introduction to SVNGit]]

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