Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Archive release process: Difference between revisions

From MoodleDocs
m (taking out redirected (to Releases) link)
(This page will not be migrated to new devdocs)
 
(32 intermediate revisions by 5 users not shown)
Line 1: Line 1:
This page describes the standard procedures for making Moodle releases.
{{Template:WillNotMigrate}}
 
{{obsolete}}
Please see the [[Release process|Release process]] page.
 


==For a stable release on an existing branch XY with point value Z (eg. X.Y.Z)==
==For a stable release on an existing branch XY with point value Z (eg. X.Y.Z)==
Line 5: Line 9:
===One week before===
===One week before===
# Notify Moodle developers and Moodle Partners about the upcoming release
# Notify Moodle developers and Moodle Partners about the upcoming release
#* Ask the AMOS maintainer to merge fixes from en_fix pack and then integrate them.
# Identify security issues that need to be integrated.
#* Integrate from provided patches into supported branches (including branches supported only for security issues).
#* Ensure security issues are given priority in weekly integration and testing.
#* Collect security issues into a clone of MDL-39530 to prepare for release of Security Advisories.
# Freeze stable development and post in the [http://moodle.org/mod/forum/view.php?id=55 General developer forum] to inform everyone of the freeze
# Freeze stable development and post in the [http://moodle.org/mod/forum/view.php?id=55 General developer forum] to inform everyone of the freeze
# Review and complete the [[:Category:Release notes|release notes]] of the upcoming version using the [[Release notes template|template]]
# Review and complete the [[:Category:Release notes|release notes]] of the upcoming version using the [[Release notes template|template]]
#* Ensure all issues labelled with "ui_change" or "api_change" are listed as functional or API changes respectively in the release notes.
#* Ensure all issues labelled with "ui_change" or "api_change" are listed as functional or API changes respectively in the release notes.
# Begin preparing the security advisories to be sent on release day
# Begin preparing the security advisories to be sent on release day.
# [[Weekly Code Review|Test / QA]] etc.
# [[Weekly Code Review|Test / QA]] etc.


===During the week prior release===
===During the week prior release===
# Normal integration / testing / upstream / weekly cycle. It will constitute, somehow, the "release candidate" to be packaged and released.
# Normal integration / testing / upstream / weekly cycle. It will constitute, somehow, the "release candidate" to be packaged and released.
# Determine which security issues will be integrated.
#* Request CVE Identifiers by emailing issue descriptions to [mailto:distros@vs.openwall.org distros@vs.openwall.org] with a message like... <tt> The following security issues have been discovered in Moodle. We request CVE Identifiers for these issues. We will be releasing the security announcements for these on moodle.org on XXX at 12noon AWST which is 04:00 UTC.</tt> The email subject should include the characters '''[vs]'''. The format needs to be plain text or encrypted. When granted CVE Identifiers, our issues should appear in the [http://cve.mitre.org/cve/cve.html CVE list]. More [http://oss-security.openwall.org/wiki/mailing-lists/distros instructions] are available.
# Create the next X.Y.Z+1 versions in the Tracker (both for the [http://tracker.moodle.org/secure/project/ViewProject.jspa?pid=10011 Moodle Project] and the [http://tracker.moodle.org/secure/project/ViewProject.jspa?pid=10033 Non-core contributed modules project]).


===Packaging day===
===Packaging day===
Line 19: Line 31:
# Make sure there are not real blockers introduced by last weekly (install / upgrade ...)
# Make sure there are not real blockers introduced by last weekly (install / upgrade ...)
# Make sure all the Unit tests pass!
# Make sure all the Unit tests pass!
# Run the [https://github.com/skodak/mdlrelease/blob/master/weeklybuild.txt mdlrelease] process, that will do, for a release:
# Run the [https://github.com/moodlehq/mdlrelease/blob/master/weeklybuild.txt mdlrelease] process, that will do, for a release:
#* Edit version.php, update release and version to new point release and commit in the integration repository
#* Edit version.php, update release and version to new point release and commit in the integration repository
#* Tag the integration repository with a tag name vX.Y.Z using "MOODLE_XYZ" as a tag message  
#* Tag the integration repository with a tag name vX.Y.Z using "MOODLE_XYZ" as a tag message  
#* push change to main git repo, github and Gitorious
#* push change to main git repo, github and Gitorious
#* sync CVS mirror (copy the version.php file and update githash.php to point to the release commit)
# Wait the automated moodle-package to finish building all the versions. Verify the process has ended ok (email).
#* '''cvs tag -FR MOODLE_XYZ''' to tag everything in the release
# In the download server:
#* '''cvs tag -FR MOODLE_XY_WEEKLY''' to make the weekly version match the release
#* Duplicate the download/index.php page and amend it with new release info and links
# '''cvs -q update -dP''' all code on download server
#* Duplicate the download/windows/index.php page and amend it with new release info (always keeping the "+")
# Run moodle-makenightlystableXY
# In the Tracker:
# Go to download/stableXY
#* Visit releases page on tracker and make the release, bumping all remaining open bugs to the next point release. This must be done both for the [http://tracker.moodle.org/secure/project/ViewProject.jspa?pid=10011 Moodle Project] and the [http://tracker.moodle.org/secure/project/ViewProject.jspa?pid=10033 Non-core contributed modules project]. Archive every released version > 6mo ago.
# Copy current daily as release package:
#* Hide from all screens the custom fields belonging to 100% unsupported branches.
#* '''cp moodle-latest-XY.zip moodle-X.Y.Z.zip'''
# Add/update the release date, build number and link on the [[Releases]] page.
#* '''cp moodle-latest-XY.tgz moodle-X.Y.Z.tgz'''
# Post a "git repos updated & tagged" done message on the [http://partners.moodle.com/mod/forum/view.php?id=2 Partner forum]
# Edit download index.php page with new release info and links
# Run moodle-makewindowspackages so all the windows packages will be rebuilt
# Edit download windows/index.php page with new release info (always keeping the "+")
# Run SF's mirror script
# Visit releases page on tracker and make the release, bumping all remaining open bugs to the next point release. This must be done both for the [http://tracker.moodle.org/secure/project/ViewProject.jspa?pid=10011 Moodle Project] and the [http://tracker.moodle.org/secure/project/ViewProject.jspa?pid=10033 Non-core contributed modules project]. Archive every released version > 6mo ago.
# Add the release date, build number and link to [[Releases]]
# Clone MDL-34199, MDL-35328, MDL-35329, MDL-35330 for next minor release X.Y.(Z+1) handling of security issues & security advisories.
# Post an "advanced release" message on the [http://partners.moodle.com/mod/forum/view.php?id=2 Partner forum]


===Release day===
===Release day===


# Verify packaging has happened
# The execution of "moodle-package-extract-and-postprocess X" script may be needed if the releases *are not going to be published on Monday* but another weekday (X is the weekday, (1-7) starting in Monday).
# Notify all registered sys admins
# Replace the download/index.php page with its updated counterpart.
# Replace the download/windows/index.php page with its updated counterpart.
# Notify all registered sys admins, including security notes with CVE identifiers.
# Post about the release in the [http://moodle.org/news/ moodle.org news]
# (deprecated) Update the Latest Release block on [http://moodle.org/news/ Moodle.org news]
# (deprecated) Update the Latest Release block on [http://moodle.org/news/ Moodle.org news]
# Post about the release in the [http://moodle.org/news/ moodle.org news]


===One week after release day===
===One week after release day===
# Update the version.php in git to be X.Y.Z+ during the next weekly integration process
# Update the version.php in git to be X.Y.Z+ during the next weekly integration process
# Create a new release notes page for the next version X.Y.(Z+1) (here you can find [[Release notes template|one template for that]])
# Add all security advisories to [http://moodle.org/security Security news] and [[:Category:Release notes|release notes]] with links to security advisories
# Add all security advisories to [http://moodle.org/security Security news] and [[:Category:Release notes|release notes]] with links to security advisories
#* (@todo: [http://feeding.cloud.geek.nz/2009/03/handling-security-bugs-in-your-free.html integrate the advisories] under the [http://cve.mitre.org/ CVE advisories] standard).
# Send a plain text email to the following email list: [mailto:oss-security@lists.openwall.com oss-security@lists.openwall.com] An appropriate message when sending the issues is... <tt>The following security notifications have now been made public. Thanks to OSS members for their cooperation.</tt> ...followed by the security notes.
# Create a new release notes page for the next version X.Y.(Z+1) (here you can find [[Release notes template|one template for that]])


==See also==
==See also==
Line 58: Line 64:
* [[Releases]]
* [[Releases]]
* [[Major release process]]
* [[Major release process]]
* MDLSITE-699: How to repackage one weekly at any moment (a.k.a. "emergency weekly").
* [[Deprecation]]


[[Category:Processes|Release process]]
[[Category:Processes|Release process]]
[[Category:Release notes|Release process]]
[[Category:Release notes|Release process]]

Latest revision as of 07:13, 26 May 2022


Warning: This page is no longer in use. The information contained on the page should NOT be seen as relevant or reliable.



Warning: This page is no longer in use. The information contained on the page should NOT be seen as relevant or reliable.

Please see the Release process page.


For a stable release on an existing branch XY with point value Z (eg. X.Y.Z)

One week before

  1. Notify Moodle developers and Moodle Partners about the upcoming release
    • Ask the AMOS maintainer to merge fixes from en_fix pack and then integrate them.
  2. Identify security issues that need to be integrated.
    • Integrate from provided patches into supported branches (including branches supported only for security issues).
    • Ensure security issues are given priority in weekly integration and testing.
    • Collect security issues into a clone of MDL-39530 to prepare for release of Security Advisories.
  3. Freeze stable development and post in the General developer forum to inform everyone of the freeze
  4. Review and complete the release notes of the upcoming version using the template
    • Ensure all issues labelled with "ui_change" or "api_change" are listed as functional or API changes respectively in the release notes.
  5. Begin preparing the security advisories to be sent on release day.
  6. Test / QA etc.

During the week prior release

  1. Normal integration / testing / upstream / weekly cycle. It will constitute, somehow, the "release candidate" to be packaged and released.
  2. Determine which security issues will be integrated.
    • Request CVE Identifiers by emailing issue descriptions to distros@vs.openwall.org with a message like... The following security issues have been discovered in Moodle. We request CVE Identifiers for these issues. We will be releasing the security announcements for these on moodle.org on XXX at 12noon AWST which is 04:00 UTC. The email subject should include the characters [vs]. The format needs to be plain text or encrypted. When granted CVE Identifiers, our issues should appear in the CVE list. More instructions are available.
  3. Create the next X.Y.Z+1 versions in the Tracker (both for the Moodle Project and the Non-core contributed modules project).

Packaging day

This should happen immediately before the next integration cycle begins on Monday (i.e., some days after last weekly, 2 days prior to official release).

  1. Make sure there are not real blockers introduced by last weekly (install / upgrade ...)
  2. Make sure all the Unit tests pass!
  3. Run the mdlrelease process, that will do, for a release:
    • Edit version.php, update release and version to new point release and commit in the integration repository
    • Tag the integration repository with a tag name vX.Y.Z using "MOODLE_XYZ" as a tag message
    • push change to main git repo, github and Gitorious
  4. Wait the automated moodle-package to finish building all the versions. Verify the process has ended ok (email).
  5. In the download server:
    • Duplicate the download/index.php page and amend it with new release info and links
    • Duplicate the download/windows/index.php page and amend it with new release info (always keeping the "+")
  6. In the Tracker:
    • Visit releases page on tracker and make the release, bumping all remaining open bugs to the next point release. This must be done both for the Moodle Project and the Non-core contributed modules project. Archive every released version > 6mo ago.
    • Hide from all screens the custom fields belonging to 100% unsupported branches.
  7. Add/update the release date, build number and link on the Releases page.
  8. Post a "git repos updated & tagged" done message on the Partner forum

Release day

  1. The execution of "moodle-package-extract-and-postprocess X" script may be needed if the releases *are not going to be published on Monday* but another weekday (X is the weekday, (1-7) starting in Monday).
  2. Replace the download/index.php page with its updated counterpart.
  3. Replace the download/windows/index.php page with its updated counterpart.
  4. Notify all registered sys admins, including security notes with CVE identifiers.
  5. Post about the release in the moodle.org news
  6. (deprecated) Update the Latest Release block on Moodle.org news

One week after release day

  1. Update the version.php in git to be X.Y.Z+ during the next weekly integration process
  2. Create a new release notes page for the next version X.Y.(Z+1) (here you can find one template for that)
  3. Add all security advisories to Security news and release notes with links to security advisories
  4. Send a plain text email to the following email list: oss-security@lists.openwall.com An appropriate message when sending the issues is... The following security notifications have now been made public. Thanks to OSS members for their cooperation. ...followed by the security notes.

See also