Actions

Difference between revisions of "Developer Area/Release Instructions"

From Mahara Wiki

< Developer Area
 
(73 intermediate revisions by 7 users not shown)
Line 1: Line 1:
This document details the procedure to follow when building a release for general download. Other documents related to this one include the [[Developer Area/Version Numbering Policy|Version Numbering policy]] and the [[Developer Area/Release Policy|Release Policy]].
+
Mahara creates 2 major releases per year (April: XX.04.0, and October: XX.10.0). We also create 'minor point' releases when we need to add urgent fixes and security updates (e.g. XX.04.1, XX.04.2 etc).  Doing minor point releases is slightly different to doing a major release. On a major release, we apply any security and bug fixes that are included in the release as a minor point ''update'' to other supported versions. Minor point ''releases'' are for security fixes or urgent bug fixes - these happen between major releases.
  
For the purposes of these instructions, assume we are releasing version X.Y.Z of Mahara.
+
==Overview==
 +
{| class="wikitable mw-collapsible"
 +
!'''STAGES'''
 +
!'''Release Candidate'''
 +
!'''Major release'''
 +
'''(XX.XX.0)'''
 +
!'''Minor point release'''
 +
'''(XX.XX.1 etc)'''
 +
|-
 +
|'''1. Release prep'''
 +
|RC Prep
 +
|'''[[Developer_Area/Release_Instructions/Pre-release|Major Prep]]'''
 +
|Minor Prep
 +
|-
 +
|'''2. The Release''' - Outcome: zip file is on Launchpad (a major release + 3 minor points)
 +
|'''[[Developer_Area/Release_Instructions/Release_Candidate|RC Release]]'''
 +
|'''[[Developer_Area/Release_Instructions/Release_day|Major Release]]'''
 +
|[[Developer Area/Release Instructions/Minor Release|'''Minor Release''']]
 +
|-
 +
|'''3. Release follow-up admin'''  - forums, bug report updating, admin etc
 +
|'''[[Developer_Area/Release_Instructions/Release_Candidate_Follow_Up|RC Follow up]]'''
 +
|✅
 +
|✅
 +
|-
 +
|'''4. Community site upgrades'''
 +
|NA
 +
|✅
 +
|NA
 +
|-
 +
|'''5. Minor point updates''' for all supported versions and clients who have paid for that support package
 +
|NA
 +
|✅
 +
|✅
 +
|-
 +
|'''6. Retro workshop'''
 +
|NA
 +
|✅
 +
|NA
 +
|}
  
'''Also see these pages for more instructions:'''
+
==Links to documentation==
  
* [[Developer Area/Release Instructions/Major Release|Major release]]
+
#A week before the release: [[Developer Area/Release Instructions/Comms|Comms]]
* [[Developer Area/Release Instructions/Release Candidate|Release candidate]]
+
#[[Developer Area/Release Instructions/Pre-release|Pre-release steps for developers]]
 +
#[[Developer_Area/Release_Instructions/Release_day|Release day steps for developers]]
  
 +
====Extra info for devs====
  
====Pre-requisites:====
+
*[[Developer_Area/Release_Instructions/Creating_a_GPG_key|Creating a GPG key]]
 +
*[[Developer Area/Version Numbering Policy|Version Numbering policy]]
 +
*[[Developer Area/Release Policy|Release Policy]]
  
* You must have a [[Developer Area/Release Instructions/Creating a GPG key|valid GPG key]] and you need to add it to Launchpad (see https://launchpad.net/~username/+editpgpkeys).
 
* You must have lp-upload-project installed:
 
  
  apt-get install lptools
+
'''OLD DOCUMENTATION (Beware: only kept for posterity)'''
  
* Configure lptools to '''write public information''' on Launchpad on your behalf:
+
*[[Developer Area/Release Instructions/Old Major Release|Old Major release]]
 
+
*[[Developer Area/Old release Instructions|Old release instructions]]
manage-credentials create -c ubuntu-dev-tools -l 2
+
*[[Developer Area/Release Instructions/Old Release script|Old Release script]]
 
 
(Note: This won't work for Ubuntus after Maverick, as manage-credentials appears to have gone away. You will need to install lptools to proceed with the script usage.)
 
 
 
===1. Make sure your mahara-scripts checkout is up to date===
 
 
 
You need to have an up-to-date version of the [https://git.mahara.org/scripts/mahara-scripts mahara-scripts] repo in order to get the latest copy of the [http://git.mahara.org/scripts/mahara-scripts/blobs/master/release.sh release script]. That's the only repo you need to have since the release script will clone the git.mahara.org repo all by itself.
 
 
 
===2. Run the first part of the release script===
 
 
 
[[File:File_Siren.gif]]'''IMPORTANT !!!'''[[File:File_Siren.gif]]
 
 
 
'''Make sure that any security reviews/patches are merged before proceeding. THESE PATCHES ARE MARKED STATUS: Draft. If you do not have the ability to see the security patches - ask someone on the security team to merge them for you.'''
 
 
 
Using the script you got in the previous step, run the first step of it like this:
 
 
 
./release.sh X.Y.Z X.Y_STABLE
 
 
 
 
This will create tarballs as well as a changelog and some release notes to paste into Launchpad. It will also spit out another script (release-X.Y.Z-cleanup.sh) to be run later.
 
 
 
Note that the repos that will be pushed back to git.mahara.org are live in your /tmp. '''Do not reboot your machine''' in the middle of doing a release or you will have to run through the release script again.
 
 
 
===3. Testing===
 
 
 
Here is the testing that needs to be done using the tarballs you generated in the last step:
 
 
 
# install the [http://seleniumhq.org/projects/ide/ Selenium firefox plugin] if you don't already have it
 
# untar the tar that release.sh generated somewhere and make sure you can connect to it and login as admin
 
# in a mahara repository, check the right branch out (X.Y_STABLE for X.Y.Z)
 
# in that repository, cd test/selenium/ &amp;&amp; ./generate-testsuites.py
 
# in firefox: Tools | Selenium IDE
 
# in Selenium: File | Open Test Suite
 
# open test/selenium/TestSuite.html
 
# set the Base URL to where you can connect to that Mahara site
 
# drop the db and create a new blank one (the selenium tests start by running the install)
 
# hit the "play entire test suite" green "play" button
 
 
 
Note: Avoid using firefox while selenium runs, it steals tabs and gets confused.
 
Note: Firebug can also confuse selenium, so it's best to turn it off while running the suite.
 
 
 
The test suite should be run both on MySQL and Postgres. Then run these manual upgrade tests (no need to run the Selenium test suite):
 
 
 
# install a fresh X.Y.Z-1 site, then upgrade to Z.Y.Z on Postgres and quickly check that everything works (create a portfolio, a blog with a blog post, a group with a forum and a forum post)
 
# repeat that last step on MySQL
 
 
 
===4. Create the release on Launchpad===
 
 
 
At https://launchpad.net/mahara/+milestone/X.Y.Z
 
 
 
Click on "create release" and give it today's date.
 
 
 
Leave "Keep the X.Y.Z milestone active." '''unchecked'''.
 
 
 
Paste in the release notes and the changelog that were generated for you by the release script. You can remove the "bump version number" commits from the changelog since they aren't very useful :)
 
 
 
===5. Sign and upload the tarballs===
 
 
 
Run the next part of the release script, i.e. the script that was spit out by the release script.
 
 
 
./release-X.Y.Z-cleanup.sh
 
 
 
You will be prompted for enter release notes and a changelog. This will happen once for each archive file that is being uploaded, so you'll see six prompts total. Any data you enter here will go into the Launchpad release page. So, you can either enter it here, or leave it empty here and enter it directly into the Launchpad webpage.
 
 
 
===6. Update bugs on the tracker===
 
 
 
On [https://bugs.launchpad.net/mahara Launchpad], click on all of the bugs targetted for that milestone and move them from "Fix committed" to "Fix released".
 
 
 
Now is also a good time to create the next release number in the series. Any remaining bugs that were not fixed for this release may be transferred to the next one, if they're still on the roadmap but were simply delayed.
 
 
 
===7. Put the release notes on the wiki page===
 
 
 
This is just adding a link to the right page on Launchpad, we no longer have a duplicate copy of the release notes on the wiki.
 
 
 
[[Release Notes|Release notes page]]
 
 
 
===8. Language packs===
 
 
 
[[Developer_Area/Language_Packs/Launchpad_Branching | Create a new translation branch on launchpad.net and update the language scripts]] for the new release so that they appear on http://langpacks.mahara.org
 
 
 
===9. Security forum posts===
 
 
 
If this release includes security fixes, then publish advisories on the [https://mahara.org/interaction/forum/view.php?id=43 security forum].
 
 
 
Here's a sample forum post:
 
 
 
Title: Security issue relating to (Category) <1.0.5, <1.1.3, <1.2.0
 
 
<description of issue>
 
 
Category: (XSS, Access control, Privacy, Spam, Privilege escalation, Session fixation, Etc.)
 
Severity: (Critical, High, Medium, Low)
 
Versions affected: <1.0.5, <1.1.3, <1.2.0
 
Reported by:
 
Bug reports: (launchpad URL)
 
CVE reference: (If you have one; if not, this can be added later)
 
 
 
Sticky: No
 
Closed: No
 
 
 
===10. News forum posts ===
 
 
 
Post announcement in the news forum at [http://www.mahara.org/ http://mahara.org/]
 
 
 
Include links to the security advisories and a link to the [https://launchpad.net/mahara/+download download page] on Launchpad.
 
 
 
Now is a good time to notify translators about changed strings, if this is a stable release. I tend to do this with a forum post in the Translations forum.
 
 
 
Here is a sample minor release announcement:
 
 
 
Title: Mahara security release: 15.04.1, 1.10.4, 1.9.6
 
 
Hi all,
 
 
Today we're announcing new minor releases for the Mahara 15.04, Mahara 1.10, and Mahara 1.9 series.
 
 
These releases include <X> major security fix<es> relating to <list of issues>, as well as several bug
 
fixes. Site administrators are advised to upgrade as soon as possible
 
 
Release packages, as well as a full list of changes, are available on our Launchpad project:
 
 
    15.04.1: https://launchpad.net/mahara/+milestone/15.04.1
 
    1.10.4: https://launchpad.net/mahara/+milestone/1.10.4
 
    1.9.6: https://launchpad.net/mahara/+milestone/1.9.6
 
 
Special thanks, as always, to everyone who helped by reporting bugs, submitting patches, and testing
 
the changes!
 
 
 
===11. Quick announcements===
 
 
 
* Create a topic in the Mahara news forum (and security forum if it's a security release) - see below for more information.
 
* Change the topic of #mahara and include a link to forum topic on #mahara-dev
 
* Put a note on:
 
** [https://twitter.com/maharaproject Twitter]
 
** [http://freecode.com/projects/mahara freecode] (formerly Freshmeat)
 
** [https://www.linkedin.com/groups?home=&gid=2037561 LinkedIn]
 
** Facebook [https://www.facebook.com/groups/maharausergroup/ MUG], [https://www.facebook.com/groups/MaharaDE13/ Mahara DE], [https://www.facebook.com/groups/moodlemaharameetup/ Moodle-Mahara Meetup], [https://www.facebook.com/groups/mahara.users/ Mahara in Japanese]
 
 
 
You may need to ask a previous release manager to get access to some of these accounts.
 
 
 
===12. Update the demo.mahara.org install (currently Catalyst hosted)===
 
 
 
demo.mahara.org is deployed using Catalyst's standard internal hosting deployment scripts. Also update the installed language packs. As a guideline, language packs that are 90% or more translated should be installed.
 
 
 
===13. Close the Y.M.0 milestone on Launchpad===
 
 
 
Once the release is done, please close the milestone for the .0 release and create the one for the .1 release if it doesn't already exist so that bugs are targeted correctly.
 
 
 
===Subpages===
 
 
 
* [[Developer_Area/Release_Instructions/Creating_a_GPG_key|Creating a GPG key]]
 
* [[Developer_Area/Release_Instructions/Release_script|Release script]]
 
  
 
[[category:Developer Area]]
 
[[category:Developer Area]]

Latest revision as of 16:40, 16 June 2022

Mahara creates 2 major releases per year (April: XX.04.0, and October: XX.10.0). We also create 'minor point' releases when we need to add urgent fixes and security updates (e.g. XX.04.1, XX.04.2 etc). Doing minor point releases is slightly different to doing a major release. On a major release, we apply any security and bug fixes that are included in the release as a minor point update to other supported versions. Minor point releases are for security fixes or urgent bug fixes - these happen between major releases.

Overview

STAGES Release Candidate Major release

(XX.XX.0)

Minor point release

(XX.XX.1 etc)

1. Release prep RC Prep Major Prep Minor Prep
2. The Release - Outcome: zip file is on Launchpad (a major release + 3 minor points) RC Release Major Release Minor Release
3. Release follow-up admin - forums, bug report updating, admin etc RC Follow up
4. Community site upgrades NA NA
5. Minor point updates for all supported versions and clients who have paid for that support package NA
6. Retro workshop NA NA

Links to documentation

  1. A week before the release: Comms
  2. Pre-release steps for developers
  3. Release day steps for developers

Extra info for devs


OLD DOCUMENTATION (Beware: only kept for posterity)