Actions

Difference between revisions of "Release procedure and checklist"

From Joomla! Documentation

m (Pages to update)
(Simplified - removed steps not pertinent to the release doc (documenting individual issues))
Line 51: Line 51:
 
#* [http://developer.joomla.org/code.html Developer Code] (Nightly links)
 
#* [http://developer.joomla.org/code.html Developer Code] (Nightly links)
 
#1.5:
 
#1.5:
#* Create new Wiki article called 'Category:Version 1.5.X FAQ'. If you like, add an overall note for the release in the body of the article and then add this category to the major version category by inserting the following into the article:  <nowiki>[[Category:Version 1.5 FAQ]]</nowiki>
+
#* Create new Wiki article called 'Category:Version 1.5.X FAQ'. Add an overall note for the release in the body of the article using the previous version as a Guide. Insert the following into the article:  <nowiki>[[Category:Version 1.5 FAQ]]</nowiki>. Include a link to the 'Category:Version 1.5.x FAQ' page in the Release notes.
#*Add any new 1.5.x FAQs, each as a separate article. (For example, the article title would be something like 'What is so special about version 1.5.x%3f'. Note that the '%3f' is used to create the "?".) Use the 1.5.7 FAQs as a guide. Be sure to put the <nowiki>[[Category:Version 1.5.x FAQ]]</nowiki> in each FAQ. Also, put other applicable categories (FAQ, Version 1.5 FAQ, Administration, etc.). (Again, you can use the 1.5.7 FAQs as a guide.)
+
#* Update [http://docs.joomla.org/Joomla_1.5_version_history Version History]
#**Include a link to the 'Category:Version 1.5.x FAQ' page in the Release notes.
+
#* [http://docs.joomla.org/Joomla_1.5_version_history Version History]
+
 
# 1.0:
 
# 1.0:
 
#* [http://dev.joomla.org/content/blogcategory/21/86/ Current Status]
 
#* [http://dev.joomla.org/content/blogcategory/21/86/ Current Status]

Revision as of 21:26, 11 September 2008


There is a general checklist when a version of Joomla! is released. Keep in mind that a major release differs a lot from a Minor Release or even a Maintenance Release. The checklist here describes the steps that need to be done for (at least) Maintenance Release and Minor Release.

Contents

Release checklist

It depends on the Development Cycle when the checklist is triggered. A release can be done during every stage of the Development Cycle, it does not matter if you release a beta or a stable version, this is a general checklist that can be used when releasing a new version of Joomla! The checklist starts when it's decided to release a version:

Preparation phase

  1. Communication pre-release: check with all Working Group Coordinators for status
  2. Communication pre-release: check with Lead Developers for status
  3. Communication pre-release: inform Bug Squad and Development Team of upcoming release
  4. Decision: when the above has positive result, set a date and time for release
  5. Communication pre-release: inform Global Moderators about upcoming release
  6. Communication pre-release: check availability and assign release tasks to Core and work-group members.
  7. Close trunk on predefined date and time (Development Coordinator, also sends an e-mail to development list).
  8. Image for front page download module, has to be modified for the release.
  9. Contact foundation work group for creation of Front page announcement.
  10. Determine release name

Pre-execution phase

  1. Apply latest translations (need to be delivered by translation work group).
  2. Create test package.
  3. Offer test package to testers: Bug Squad members, Development Team members, translation members
  4. If problems are found during this stage, go back to fix the problem. Use the Joomla! Maintenance Procedures and repeat until tests are performed successfully.

Execution phase

  1. Change version information.
  2. Enable install check.
  3. Add entry in CHANGELOG.php file
  4. Package build.
  5. Offer test package to testers: Bug Squad members, Development Team members, translation members
  6. If problems are found during this stage, go back to fix the problem. Use the Joomla! Maintenance Procedures and repeat until tests are performed successfully.
  7. Add package to joomlacode.org
  8. Publish announcement on joomla.org and the forum, change download module image and link
  9. Make static copy of front page with announcement to be used if server load becomes critical.

Finalization phase

  1. Tag SVN.
  2. Un-freeze the trunk, send e-mail to work groups and mailing lists (Development Team and Bug Squad).
  3. Undo install check.
  4. Change content on joomla.org and dev.joomla.org (see pages to update)
  5. Update MD5 checksum information
  6. Update nightly builds to reflect new release

Pages to update

  1. Global:
  2. 1.5:
    • Create new Wiki article called 'Category:Version 1.5.X FAQ'. Add an overall note for the release in the body of the article using the previous version as a Guide. Insert the following into the article: [[Category:Version 1.5 FAQ]]. Include a link to the 'Category:Version 1.5.x FAQ' page in the Release notes.
    • Update Version History
  3. 1.0:

Communication

For boiler-plate communication messages, see Release Communication Templates.