Differences

This shows you the differences between two versions of the page.

--- mantisbt:release_process [2014/02/08 15:36] – Added prerequisites section dregad
+++ mantisbt:release_process [2019/08/08 19:29] – [Repository Preparation] link to new mailmap page dregad
@@ Line 18: / Line 18: @@
-===== Readiness =====
+===== Planning the Release =====
+This activity should start about 2 weeks before the planned release date.
+==== General Readiness ====
   * Review the issues in bugtracker to make sure there are no critical issues that need to be included in the release.
   * Check with the developers (via the mailing list and/or IRC) that there are no pending issues for the release.
-===== Testing =====
+==== Testing ====
   * General testing.
@@ Line 37: / Line 41: @@
    * optional features (e.g., graphs)
-The test process for Mantis in the Debian distro can be found at http://svn.debian.org/wsvn/collab-maint/ext-maint/mantis/trunk/debian/TestingNewRelease?op=file&rev=0&sc=0 .
+For reference, you may also read the [[http://anonscm.debian.org/viewvc/collab-maint/ext-maint/mantis/trunk/debian/TestingNewRelease?view=log|test plan for new Mantis releases in Debian]].
-===== Localization =====
+==== Localization ====
+  * Post on the [[mantisbt-lang@lists.sourceforge.net|Localization mailing list]] to request translation updates from contributors
   * Run /admin/test_langs.php to detect any syntax errors in the localization files.
-===== File Cleanup =====
+==== File Cleanup ====
   * Run the Lines Termination test script on all the files to make sure the line terminations are UNIX style. <code>
@@ Line 59: / Line 64: @@
+===== Preparing the Release =====
+==== Localization ====
-===== Preparation =====
+  * Contact the [[http://translatewiki.net|TranslateWiki]] team (Siebrand) to request an update of tranlations
+==== Repository Preparation ====
   * Remove references to any debug statements
-  * Make sure enough testing is done for the main functionality and the admin section (see the "Testing" section).
   * Update CREDITS file.
-    * If necessary, update the ''.mailmap'' file at the repository's root, so that commit made by the same person under different names and/or e-mail addresses are properly aggregated (refer to [[http://www.kernel.org/pub/software/scm/git/docs/git-shortlog.html#_mapping_authors|git shortlog man page]] for details)
+    * If necessary, [[mantisbt:mailmap|update the .mailmap file]], so that commit made by the same person under different names and/or e-mail addresses are properly aggregated
     * Run the script to update the Contributor's list <code>
 $ update-credits.sh
@@ Line 72: / Line 80: @@
     * If needed, make any additional changes manually
   * Update the version number in core/constant_inc.php.
-  * Update doc/RELEASE to include the release notes.
   * Commit the changes.
-===== Repository =====
-  * Create an annotated tag in Git, the tag should be formatted as "release-1.x.x"
+===== Cutting the Release =====
-    * For stable releases: GPG-signed tag <code>
+  * Create an annotated, GPG-signed tag in Git; the tag should be formatted as "release-1.x.x" \\ \\
+     * For **stable releases** <code>
 $ git checkout master-1.M.x
 $ VERSION=1.M.N
 $ git tag -s release-$VERSION -m "Stable release $VERSION"
 </code> Note: If this fails, see below for tag signing troubleshooting
-    * For development releases: unsigned, annotated tag <code>
+    * For **development releases** (e.g. alpha, beta, release candidates) <code>
 $ git checkout master
 $ VERSION=1.M.N
-$ git tag -a release-$VERSION -m "Development release $VERSION"
+$ git tag -s release-$VERSION -m "Development release $VERSION"
 </code>
@@ Line 103: / Line 111: @@
 **Troubleshooting failure to sign tags**
-Signing the tag fail if GIT cannot map the user with the gpg key, as in the example below <code>
+Signing the tag fails if GIT cannot map the user with the gpg key, as in the example below <code>
 $ git tag -s release-$VERSION -m "Stable release $VERSION"
 gpg: skipped "Your Name <name@example.com>": secret key not available
@@ Line 123: / Line 131: @@
-===== Packaging =====
+===== Packaging the Release =====
 Generate release tarballs using the ''buildrelease-repo.py'' script found in the ''mantisbt-tools.git'' repository:
@@ Line 130: / Line 138: @@
 </code>
-This will create a .zip and .tgz tarball of the release, and create a .digest file for each tarball with md5 and sha1 hashes, all in the ''/path/to/output'' directory specified in the command.  The ''--docbook'' option will automatically build single-file versions of the manuals into the tarball's ''/doc'' directory.
+This will create a //.zip// and //.tar.gz// tarball of the release, and create a //.digest// file for each tarball with //md5// and //sha1// hashes, all in the ''/path/to/output'' directory specified in the command.  The ''--docbook'' option will automatically build single-file versions of the manuals into the tarball's ''/doc'' directory.
 [dregad] the script also creates '.asc' files, which are not documented in SourceForge section - what to do with them ?
-===== Source Forge =====
-  * Upload the release to Source Forge via the File Manager web interface
-  * Release through the SF.net mechanism.
-    * The release name should be "1.2.x" (e.g. 1.2.9).
-    * Put the release in the appropriate package based on whether it is a stable or a development release.
-    * Release candidates and alphas are "development" releases.
-  * Download the release off SF.net and verify correctness.
-  * Click the "i" next to the files under the folder and do the following actions:
-    * for digests, exclude them from stats.
-    * for zip make it default for all platforms.
-    * for README file exclude from stats. [1]
-  * Post news on Mantis SF project area.
-[1] [dregad] The Build release script does not generate a README file - maybe this is obsolete
+===== Updating mantisbt.org =====
-===== Bugtracker =====
+==== Bugtracker ====
   * Update Versions
     - Go to the //Manage Projects page// for the //mantisbt// project
-    - Update the version being released (//1.M.x//):
+    - Update the version being released (''1.M.x''):
-      * Rename it to //1.M.N//
+      * Rename it to ''1.M.N''
-      * Update the "Date Order" field to the actual release date
+      * Update the //Date Order// field to the actual release date
-      * Copy-paste the text from the release notes into the "Description" field, update as appropriate
+      * Copy-paste the text from the release notes into the //Description// field, update as appropriate
-      * Tick the "Released" box
+      * Tick the //Released// box
-    - Create a new //1.M.x// version
+    - Create a new ''1.M.x'' version
-      * Set the "Date Order" field to a future date
+      * Set the //Date Order// field to a future date <WRAP important 90%>
-      * Make sure the "Released" box is not ticked
+The [[mantisbt:plugins:sourceintegration]] relies on this date to automatically set the //Fixed in version// field when processing commits referencing issues for resolution (i.e. ''Fixes #xxx'').
+For this to work properly, it is important that the **version targeted by the //master// branch always has the most recent date**. Adjust it if necessary (e.g. when cutting a patch release).
+</WRAP>
+      * Make sure the //Released// box is not ticked
   * Update issues
     - Go to the //View Issues page//
     - Close all resolved issues that are fixed in the version being released
-      * Set a new filter: //Status// = resolved, //Fixed in Version// = 1.M.N
+      * Set a new filter: //Status// = resolved, //Fixed in Version// = ''1.M.N''
       * Review listed issues, update them as needed (in particular, check that //Resolution// = fixed)
       * Tick the //Select all// checkbox
@@ Line 176: / Line 173: @@
       * Click the //Close Issues// button
       * Repeat until the filter is empty
-    - Carry open issues still targeted to 1.M.N over to the new 1.M.x version
+    - Carry open issues still targeted to ''1.M.N'' over to the new ''1.M.x'' version
-      * Set a new filter: //Hide Status// = closed (And Above), //Target Version// = 1.M.N
+      * Set a new filter: //Hide Status// = closed (And Above), //Target Version// = ''1.M.N''
       * Tick the //Select all// checkbox
       * Select //Update Target Version// and click OK
-      * Select //1.M.x// from the list and click the //Update Target Version// button
+      * Select ''1.M.x'' from the list and click the //Update Target Version// button
       * Repeat until the filter is empty
-===== Website =====
+==== Website ====
   * Update the //latest version//
@@ Line 190: / Line 187: @@
     * Update ''$g_latest_version_stable'' or ''$g_latest_version_dev'' as appropriate, to match the version being released
+==== Nightly builds ====
-===== Deployment =====
+When releasing a new //major// (X+1.0.0) or //minor// (X.Y+1.0) release, the nightly builds script must be updated so that the files are generated for the appropriate branches.
+  * Edit the script ''/srv/mantisbt-tools/nightly-builds.sh''
+  * Update the //branches// variable to specify the names of all the repository branches for which a nightly build is required
+To make the change permanent, the file should be committed to the //mantisbt/mantisbt-tools// repository.
+If desired, the script may be executed manually at this point. Note that it normally does not produce any output; check the log file at ''/var/log/nightly-builds.log'' for errors.
+<code>$ sudo /srv/mantisbt-tools/nightly-builds.sh</code>
+==== Deployment ====
 This section describes how to deploy the new release on the official and demo bugtrackers on http://mantisbt.org.
@@ Line 198: / Line 208: @@
-===== Automated process (Update script) =====
+=== Automated process (Update script) ===
   * Execute the following steps, running as root, to update both trackers: <code>
@@ Line 211: / Line 221: @@
 Please refer to the script's help and comments for further details on command-line options.
-===== Manual process =====
+=== Manual process ===
-Also refer to MantisBT Administration Guide [[http://www.mantisbt.org/docs/master-1.2.x/en/administration_guide/admin.install.upgrade.html|upgrade section]].
+Also refer to MantisBT Administration Guide [[http://www.mantisbt.org/docs/master-1.3.x/en-US/Admin_Guide/html-desktop/#admin.install.upgrade|upgrade section]].
 **Upgrade Official Bug Tracker Instance**
@@ Line 220: / Line 230: @@
   * Update the code from git <code>
 $ cd /srv/www/bugs/
-$ git checkout master-1.2.x
+$ git checkout master-1.3.x
 $ git pull --rebase
 $ git checkout bugs
-$ git rebase master-1.2.x
+$ git rebase master-1.3.x
 </code>
   * Upgrade the database if needed (admin/admin_upgrade.php).
@@ Line 230: / Line 240: @@
-**Upgrade Demo Instance**
+===== Publishing the Release =====
-  * Make sure you are running as root (sudo bash)
-  * Update the code from git <code>
-$ cd /srv/www/demo/
-$ git checkout master-1.2.x
-$ git pull --rebase
-$ git checkout demo
-$ git rebase master-1.2.x
-</code>
-  * Upgrade the database if needed (admin/admin_upgrade.php).
-  * Run admin/admin_check.php and resolve any issues.
-  * Login and do simple testing.
-===== Notification =====
+==== Source Forge ====
+  * Upload the release to [[http://sourceforge.net/projects/mantisbt/files/|SourceForge]] via the File Manager web interface
+  * Release through the SF.net mechanism.
+    * The release name should be "1.3.x" (e.g. 1.3.3).
+    * Put the release in the appropriate package based on whether it is a stable or a development release.
+    * Release candidates, alphas and betas are "development" releases.
+  * Download the release off SF.net and verify correctness.
+  * Click the "i" next to the files under the folder and do the following actions:
+    * for digests, exclude them from stats.
+    * In case of a stable release, make the zip file the default for all platforms.
+==== Notifications ====
   * Blog: Post an announcement
   * Twitter: announce the release via mantisbt twitter account.
-  * IRC: Change the title of #mantishelp to announce the new release and encourage people to use it.
+  * Update mailing list based on official bug tracker users since users can now signup to our bugtracker to get such announcements.
-  * Forums: Announce the release on the Announcements forum.
+  * Use sendgrid to send out the announcement email.
-  * Mailing Lists: Send a message to mantisbt-announce / mantisbt-dev to announce the new release and encourage users to upgrade.  Include a link to the version changelog.
+===== Prepare for next release =====
+==== Bump the version number ====
+The MantisBT version constant must be increase to reflect the current state of the development branch.
+This ensures that people running Mantis from the GIT repository are not led to believe they are working with an official release, and allows the [[https://mantisbt.org/builds.php|Nightly builds]] to reference the proper version in the zip/tarball file name.
+  * Edit ''core/constants_inc.php''
+  * Update //MANTIS_VERSION// by incrementing the version number as appropriate:
+    * Major version: **x+1**.0.0**-dev**
+    * Minor version: x.**y+1**.0**-dev**
+    * Patch version: x.y.**z+1-dev**
+  * Commit and push the modified file