View source for Developer Area/Release Instructions/Template:The Release

<br />
==📋 Final checks==
🟡 '''Security team''' (if you don't have +2 review status, you won't be able to see these patches)

🚨 Make sure that any security reviews/patches are merged before proceeding 🚨

*Merge the 'Private' security patches.
*Update the related Launchpad bugs to 'Public security'.

🟡 '''Release manager'''

*CVE #'s - Security issues have an assigned CVE number?
*Backporting - security fixes backported to all supported versions that need them?
*Bugs fixed - all bugs going into his release have their fixes ''merged'' for all supported versions?
*Comms - to Mahara partners + drafted the [[Developer Area/Release Instructions/Pre-release investigation and tasks#.F0.9F.93.B0 Comms|forum posts]]?

🟡 '''All devs'''

*Confirm your minor point release number, i.e. check the latest minor point release and add 1, e.g. 21.10.4 -> 21.10.5
*(Security team) Cherry-pick the security bugs with the status ' Confirmed' to your minor point branch. e.g. _DEV
*Create a [[Developer Area/Release Instructions/Pre-release investigation and tasks#Creating a release on Launchpad|release]] on the milestone on Launchpad to receive the release generated tarballs
*<code>git pull [https://git.mahara.org/scripts/mahara-scripts mahara-scripts]</code>
*Valid GPG - ensure you have a [https://wiki.mahara.org/wiki/Developer_Area/Release_Instructions/Creating_a_GPG_key valid GPG key] added to your Launchpad account: See https://launchpad.net/~username/+editpgpkeys
*<code>lptools</code> - ensure you have the lp-upload-project installed for uploading the release tars: <code> apt-get install lptools</code>

==📓 Changelog and release notes==
Use the templates below to structure your changelog and release notes.
====(Release candidate) Skip the changelog and release notes====
Do not populate the changelog. For the release notes put something like ''<nowiki/>'First release candidate for 1.4''<nowiki/>'.
''<nowiki/>''
====Changelog template====
Note: You can copy the list of bugs from the milestone page (https://launchpad.net/mahara/+milestone/XX.YY.Z) and re-format the list.

[[File:Changelog template.png|720x720px|link=https://wiki.mahara.org/wiki/File:Changelog_template.png]]
====Release notes templates====
See paste: [https://paste.wgtn.cat-it.co.nz/BjqzmddeQ8RLPOhq#HJYM6/6JF46ErvKAHVR0Lw$0 release notes template for major releases].

[[File:Major release release notes 21.10.png|774x774px|link=https://wiki.mahara.org/wiki/File:Major_release_release_notes_21.10.png]]

See paste: [https://paste.wgtn.cat-it.co.nz/1Nf6ZBfG7H5azgP6#D668H8zI4mhgupx98Z50iA$0 release notes template for minor point releases].

[[File:Minor point release release notes.png|484x484px|link=https://wiki.mahara.org/wiki/File:Minor_point_release_release_notes.png]]
==⚡ The release script==

*A git repo will be created at <code>/tmp/mahara.####/mahara/</code> cloned from https://git.mahara.org/mahara/mahara .
*It builds Mahara archives based on the given _DEV branch and puts thme into your current folder. ( <code>.zip</code>, <code>.tar.gz.asc</code>, and <code>.tar.bz2.asc</code>)
*You will get a <code>release-X.Y.Z-cleanup.sh</code> script to run later.
*(Major releases .0) A new <code>_STABLE</code> branch is created off the <code>_DEV</code> branch.

===Run the script===

#Go into <code>mahara-scripts</code> and <code>git pull</code> the latest version.
#Run <code>./release.php X.Y.Z  X.Y_DEV</code>.
#*<code>X.Y.Z</code> is the new branch that will be made. This is also used in the archive file names.
#*<code>X.Y_DEV</code> is the existing branch we will create the new release from.
#*If the <code>Z</code> in <code>X.Y.Z</code>  is "0" this will also create a new <code>_STABLE</code>  branch.
#When prompted, insert your changelog.

Any data you enter for the prompts will go into the Launchpad release page. You can enter it here, or leave it empty here and enter it directly into the Launchpad webpage.

'''Check the terminal output in case there are GPG errors'''

E.g. <code>Tag new version bump commit as 'X.YRC2_RELEASE' error: gpg failed to sign the data error: unable to sign the tag</code>

So this is what I did to fix it, all commands are on command line:

#Update the gpg program with: <code> git config --global gpg.program gpg2 </code>
#Test if it is working with: <code> echo "test" | gpg2 --clearsign</code>

It wasn't so I had to do: <code> export GPG_TTY=$(tty)</code>

then run again <code> echo "test" | gpg2 --clearsign</code>

Run <code>release.php</code> command again and check if it still gives the error.

'''Do not reboot your machine''' in the middle of doing a release or you will have to run through the release script again.

Note: For release candidates the commit message should be empty.
==✅ Testing==
With continuous Behat testing throughout development, we only need to some basic manual testing.
===Extract the build and prep the database===
Test that we can install Mahara with the pre-built packages.

#Extract the build (<code>.tar</code> or <code>.zip</code>) of your pre-built Mahara and make sure you can connect to it via web installer.
#Drop the database and create a new blank one.

===Test case #1: Install the site with the web interface===

#Go to your Mahara site and click 'Install'.
#Reset your database and repeat with MySQL/PostgreSQL.

'''Note:''' If we are doing a <code>.0</code> release the install will complain about missing <code>$versions->$currentmajorversion</code>->latest release number but don't panic this is because the local copy of the release has the series version that doesn't exist upstream yet so we can ignore this warning·
===Test case #2: Manual upgrade with the CLI and the web interface===
Web interface

#Install a fresh site on version <code>X.Y.Z(-1)</code>, i.e. (an earlier version).
#Create a portfolio, a blog with a blogpost, a group with a forum and forum post.
#Switch the code to your current release.
#Check that everything still works.
#Go to the site and click 'Upgrade' to get the site version to <code>X.Y.Z</code> .
#Repeat with PostgreSQL/MySQL.

CLI

#Install a fresh site on version <code>X.Y.Z(-1)</code>, i.e. (an earlier version).
#Create a portfolio, a blog with a blogpost, a group with a forum and forum post.
#Switch the code to your current release.
#Upgrade to <code>X.Y.Z</code> with the CLI script <code>htdocs/admin/cli/upgrade.php</code>
#Check that everything still works.
#Repeat with PostgreSQL/MySQL.

==🚀 Sign and upload the tarballs==
Run <code>./release-X.Y.Z-cleanup.sh</code> to upload the release and clean up any temporary files.

'''Note I''': If running this file stops before completion for any reason you will need to edit it and comment out the bits that did finish so that you don't run those buts twice then try the script again. For example the script does the bit where it pushes the tag to the git remote and signs the zipped files but doesn't upload them - you would need to comment out the 'git push' lines and the 'gpg --armor' lines.

'''Note II''': If the zipped files fail to upload to Launchpad via the script then you will need to manually upload the zipped files and their corresponding .asc files. To do this go to the milestone page in Launchpad and click the 'Add download file' link. Set the description to: release tarball and choose the matching zipped and .asc file to upload. You will need to do this for all the three types: <code>.zip, .tar.bz2, .tar.gz</code>
==🐛 Update bugs statuses==
Go to Launchpad and click on all of the bugs targeted for that milestone and move them from 'Fix committed' to 'Fix released'.

'''OR'''

In Firefox, go to the milestone page and open all the bugs in new tabs at once by pasting the following into the browser console.
 var result = document.evaluate("//tbody//tr[contains(., 'Committed')]//a[contains(@href, 'bugs')]", document, null, XPathResult.ANY_TYPE,null ); var mycount=0; while(node = result.iterateNext()) { window.open(node.href, '_blank'); mycount++; if (mycount == 50) { break; } }
You will ned to allow popups for the site for this to work and it will open up to 50 bugs where the status is 'Committed'. If you have more than 50 to do - mark the first ones 'released' - refresh the list and do again.

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.
==📔 Update your milestone==

#Paste your release notes into the 'Release notes' area.
#Check that the milestone is inactive now that it has a release.

[[File:Inactive milestone.png|alt=Screenshot showing the status for a milestone for it is 'inactive'.|link=https://wiki.mahara.org/wiki/File:Inactive_milestone.png]]
==📗 Update wiki.mahara.org releases page==

#Go to the [[Releases|releases page]]'s section 'Current and upcoming releases.'
#Update the text: ''"The latest '''stable''' version of Mahara is <code>MAJOR_VERSION</code> , released on <code>DATE</code>"''
#Add a new row for the major release. (If you edit the area, there is a template available to copy)
#Add the release date and release notes for the minor point releases.
#Update the major version where 18 months has passed since its release to be 'unsupported'.

[[File:Updating current and upcoming releases.png|799x799px|link=https://wiki.mahara.org/wiki/File:Updating_current_and_upcoming_releases.png]]
==🌏 Update the 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/ http://langpacks.mahara.org].

Check that the language packs have updated:

#Install a site on the released version.
#Install the Japanese language pack (a fully translated lang pack is easier to check with)

Note: The number of language packs we support can be more than the supported Mahara versions as some people want to update old lang packs.
==📣 Announcements==
General announcements

#Publish your prepared [https://mahara.org/interaction/forum/view.php?id=43 security forum] and [https://mahara.org/interaction/forum/view.php?id=1 news forum] posts.
#(RC only) Publish news [[Developer Area/Release Instructions/Release day#.28Release candidate.29 Announcements|forum posts to get people to test the release]].
#(Major release only) Publish news [[Developer Area/Release Instructions/Release day#.28Major release.29 Announcements|forum posts to announce the major release.]]

==🔒 Update MITRE about release for CVE number publication==
🟡   Kristina

If the release included security updates for which CVE numbers had been issued, [https://cveform.mitre.org/ request an update to the CVE number] so it can be published.