Developer Area/Release Instructions/Pre-release
From Mahara Wiki
< Developer Area | Release InstructionsRevision as of 15:54, 27 April 2022 by Doristam
This document details the steps to follow in preparation of a release.
📣 Please complete these steps a week before the release, especially announcements to Mahara Partners.
Done? > Go to 'Release day'
📋 Checklist before starting
🟡 Start up
- Who is leading the release, i.e. the 'Release manager'?
- What type of release? release candidate, major release, or minor-point release
- Is your mahara-scripts repo is up-to-date so that you have the latest release script? The release script will clone the git.mahara.org repo.
- Do you have a valid GPG key added to your Launchpad account? See https://launchpad.net/~username/+editpgpkeys
🟡 Release manager - check permissions
- Are you are a member of the security group so you can see security bug reports?
- Can you create new topics in both the News and Security Announcement forums?
Ask the tech lead/product owner for permissions if you cannot check off any of the steps.
🔒 Apply for CVE numbers for security fixes
Apply for a CVE number as soon as a bug report exists for a security issue. CVE numbers that we receive are embargoed are details are not leaked until we let MITRE know that they can be published. Catalyst NZ staff also have access to that information on Seafile along with a running record of which bugs have been reported to MITRE (or others if needed).
While CVE numbers are not a requirement, it is good practice and they are useful for administrators who monitor security announcements. 🛑 Note: This MITRE CVE form can ONLY be used if the issue hasn't been made public yet.
- Apply for CVE numbers for each non-public security issue with the MITRE request form
- Add the CVE number to the security bug report using the 'Link to CVE' option on the sidebar. Note: it takes a few days for Launchpad to accept the CVE number.
- Prepare the security announcement post in the Launchpad bug report through comments or updating the description.
Security forum post template Title... in Mahara before affected versions Vulnerability type: ... Attack type: ... Impact(if needed): ... Affected components: ... Description: Affected Mahara versions, and summary of issue. Reported by: ... Bug report: Launchpad ID and URL to the bug report)
🐛 Prep branches, milestones, and bugs
Release candidate (RC)
(RC) Create a new
This branch is only created once per major version during the first RC. Subsequent release candidates shall use the same branch.
Create a new
_DEV branch based off of main.
git checkout main
git checkout -b 1.10_DEV
git push gerrit 1.10_DEV
If Gerrit won't let you push your new branch, create it through https://reviews.mahara.org/admin/repos/mahara,branches
Commit and push these changes:
- In the
Makefileof the new
mainwith the name of the branch.
- Create an empty 'ChangeLog' file. The file needs a capital C and L in the name.
- Update the release in
(RC) Bump the version on
- Go to the main branch and bump the version to
1.5.0dev(if you just created the
htdocs/lib/version.php(update series, release and version - version should be today's date)
- Commit and make push
(RC) Do not create a release
Bugs should not have an RC as its milestone. Leave them as 'Fix committed'.
Note: For organising bugs after the first release candidate, an rc2 milestone may be created for to track which ones will go onto the final release. Once an rc2 bug has been committed, their status should change back to its original .0 milestone.
Major release (M)
These are done at the end of April and October.
(M) Update the README
README.md file and update it to reflect any changes:
- Check the supported versions of PHP, Postgres, and MySQL / MariaDB.
- Check the minimum browser requirements.
- Update the copyright message so it extends to the current year.
- Update the Software requirements page to match the changes.
Note: For PHP versions, the minimum and maximum supported version needs to be listed to avoid confusion as PHP does release versions more frequently.
Minor points and security releases
We release minor point updates for all the supported released versions of Mahara during security releases and after major releases.
Create a release on Launchpad (excludes RC)
Go to https://launchpad.net/mahara/+milestone/
X.Y.Z OR Go to the series page and click 'Create milestone'.
- Move any bugs that are not going to be part of this release to the next milestone in the series, e.g. if this is
X.Y.3then move to
X.Y.4. You may need to make the milestone if it doesn't already exist via
https://launchpad.net/mahara/X.Yand using the 'create milestone' link.
- Click on 'Create release' and give it today's date.
- Double check that 'Keep the X.Y.Z milestone active' remains unchecked.
🌏 Prep the new language packs
You need to set up launchpad translations for the new branch. See the separate instructions on setting up a new translations branch.
🟡 Initial investigation and meeting
Check bug reports and their statuses
- Book a meeting with the tech lead, product owner, and those working on the release.
- Get the series number for each supported Mahara version, e.g. 21.10, 21.04, and 20.10.
- Go to Mahara's Launchpad to check there is an unreleased milestone for each supported series number. See above for how to create new milestones.
- Go through each bug report and check they have allocated milestone(s). If they don't, ask the Tech lead where to allocate them.
Track the associated bug reports
- Create a spreadsheet to track the bugs. [ethercalc.net/track-bugs Example template]
- Go through each supported milestone's bugs:
- See associated bugs for a milestone by going to 'Series and Milestones' and clicking the first milestone with an empty circle above it.
- Record the progress status of the bug, i.e. if there someone is working on it, and the patch URL in reviews.mahara.org
- Double check that all 'Private security' bug reports with patches that are ready, go into the release.
Meet with the team
This is often skipped and organised by project manager and tech lead.
- Filter through which go into the upcoming release and which ones can be pushed to the next available milestone.
- Change a bug report's milestone to the next one available if the fix will not be ready by the release date.
- Update your spreadsheet daily
- Check-in with team members working on bugs going into the release daily
- Get bugs code-reviewed, verified, and merged by delegating tasks to team members.
- Backport security patches into supported Mahara versions.
Let Mahara Partners know one week before the release
🚨 Note: Kristina does this task as a member of the Mahara partners group.
Let Mahara Partners know in the Partner forum that a release is upcoming. Details are not shared though as the reports are still embargoed.p
Draft the Security Announcements forum post
Draft the News forum post for the security releases
Take the URLs of the newly created security announcement forum posts and insert them into the following template to look something like this.
Note: links to the Security Announcements forum posts will be available once created one the day of the release.
Title: Mahara security releases <insert milestones part of this release>
Kia ora Mahara community,
We have security updates available for all supported versions of Mahara:
These updates include fixes for a number of security vulnerabilities for which you can find more information:
You can download the latest versions from Launchpad or check out the relevant branch from Git. We recommend you update your instance of Mahara to the latest minor point release of the series of Mahara you
are using, or if you are on an unsupported version of Mahara, upgrade to a supported one.
<Name of person leading the release>
📉 Daily progress monitoring
- Update your tracking of bugs daily
- Share with the team what needs doing to progress and delegate tasks
- Is everything set up for the main GoCD pipelines