Actions

Release procedure and checklist

From Joomla! Documentation

Revision as of 09:48, 1 August 2013 by NickSavov (Talk | contribs)


This 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 PLT on timing
  2. Communication pre-release: inform Bug Squad and LT's about timing
  3. Decision: when the above has positive result, set a date and time for release
  4. Communication pre-release: inform Global Moderators about upcoming release
  5. Communication pre-release: check availability and assign release tasks to JBS and PLT members
  6. 5 days prior to release: freeze trunk for language changes
  7. 2 days prior to release: freeze trunk for all changes, draft release notes to translation teams
  8. 1 day prior to release: build packages for testing
  9. Day of release: set project flags on Joomlacode, update web pages
  10. Announce on forum, announce to LT's

Pre-release 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.
  5. Draft the release notes on Joomla.org and post draft to the private translation forum.
  6. Obtain any CVE numbers needed.
  7. Draft security notices as needed and leave unpublished on developer.joomla.org.

Release phase

  1. Check for security fixes.
  2. Create release notes document on joomla.org and post copy to translation forum.
  3. Change version information (libraries/cms/version/version.php)
  4. Add entry in CHANGELOG.php file
  5. Update administrator/manifests/files/joomla.xml file for version number and date.
  6. Check joomla.sql file for version number in #__extensions table for Joomla CMS extension
    • mysql, sqlazure, postgres
  7. Make sure there is at least one .sql update file in the com_admin/sql/updates/<db> folders (to update the db schema).
  8. Update the build.php for the new version number.
  9. Check language/en-GB/en-GB.files_joomla.sys.ini file for version number (not needed for minor update).
  10. Enable install check.
  11. Tag release in git and commit to local github repo.
  12. Package build.
  13. Offer test package to testers: Bug Squad members, Development Team members, translation members
  14. 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.
  15. Add release notes at developer.joomla.org. There is a release notes menu and you can copy a menu item from there and modify appropriately. Just fill in the options with the tracker item #'s, which you can get from the github changelog in the installation folder of the branch. Or enter the dates if we can do it automatically. e.g. if you enter July 1st-31st, it will display all the tracker items that were fixed during that time. Then you can exclude a few if needed or you can put a false date and include manually.
  16. Add package to joomlacode.org
    1. Before the release is public, set the joomlacode package flags as follows: Visible=No, Public=No, Require Login=Yes.
    2. Set the Release flags as follows: Visible=Yes, Released=Yes.
    3. Once package is released, change the Package flags to Visible=Yes, Public=Yes, Require Login=No.
    4. Change the prior version package to Visible=No but leave the prior version release flags as they are.
  17. Update XML file on site for the new version number information.
    1. FTP connect to update1.joomla.org and Navigate to www/core
    2. All releases
      1. Change version attribute in list.xml (don't add new line)
    3. LTS Release
      1. Add new update element (copy from previous) with new version number and new downloadurl and link to new archive file to extension.xml
    4. STS Release
      1. Navigate to www/core/sts
      2. Change version attribute in list_sts.xml (don't add new line)
      3. Add new update element (copy from previous) with new version number and new downloadurl and link to new archive file to extension_sts.xml
    5. Test auto update from prior version(s) (make sure XML files have been copied to the SDN on update.joomla.org first)
      1. All releases
        1. Navigate to www/core/test
        2. Change version attribute in list_test.xml (don't add new line)
      2. LTS
        1. Upload patch package to this folder
        2. Add new update element (copy from previous) with new version number and new downloadurl and link to new archive file to extension_test.xml
      3. STS
        1. Navigate to www/core/teststs
        2. Upload patch package to this folder
        3. Add new update element (copy from previous) with new version number and new downloadurl and link to new archive file to extension_sts.xml
  18. Update Joomla.org Download article
  19. Publish security articles on developer site.
  20. Publish release announcement on Joomla.org
  21. Publish announcement on the forum
  22. Update download page
  23. Update Wiki: FAQ, Version history
  24. Email OSM list
  25. Create the Web Platform Installer packs and submit them

Post-release & Finalization phase

  1. Merge release branch to series development head (2.5 -> 2.5.x branch, 3.x -> master branch)
  2. Push release changes from local to remote Github repo
    1. Security fixes (if any)
    2. Version tag
    3. Version changes (SQL files, version.php, joomla.xml)
    4. Install checks
  3. Update Github repo for new version development
    1. Remove install checks
    2. Update version in version.php, joomla.xml, SQL files, SQL update files
  4. Delete old release branch after confirming all commits are merged to series development head
  5. Close security issues in security tracker

Pages to update

  1. Global:

Sites to update

  1. PLT Owned sites

Calculating Release Statistics

  1. Extract *all* issues from Tracker into spreadsheet. Make note of the date of the last release and the number of active issues at the time of the last release.
  2. Set a filter on the "Closed Date" column to be "after" "the day of the last release".
    • Calculate "Closed" count by aggregating status values for Closed, Duplicate Report, Known Issue, Not a bug, Not Joomla! Core, Unable to Confirm.
    • Calculate "Fixed in SVN" count by aggregating status values for Open and Information Required. (Note: this value is presented two times in the report.)
  3. Set a filter on the "Closed Date" column to be blanks:
    • Calculate "Open" count by aggregating status values for "Open" and "Information Required."
    • Calculate "Confirmed" count by aggregating status values for "Confirmed" and "In Progress."
    • Calculate "Pending" count by aggregating status values for "Pending" and "Ready to Commit."
  4. Calculate the "New Active Issues" by aggregating the "Open", "Confirmed" and "Pending" counts.
  5. Calculate the "net increase/decrease" by subtracting the "Last Release Active Issues" from the "New Active Issues."
  6. Count the "number of commits" by reviewing the CHANGELOG.php file and counting the documented commits.

Alternative Method for Stats

  • Fixed in SVN: Create query with close date > date of prior release and status = Fixed in SVN.
  • Commits: Count from CHANGELOG.php as indicated above.
  • New Reports: Run query with all status codes and open date > date of prior release.
  • Increase / decrease in active issues: See note below
  • Closed: Run query with closed date > date of prior release and status code one of Closed, Duplicate Report, Known Issue, Not a bug, Not Joomla! Core, Unable to Confirm.
  • Open at time of release: query of all issues with status = Open or Information Required
  • Confirmed at time of release: query of all issues with status = Confirmed or In Progress
  • Pending at time of release: query of all issues with status = Pending or Ready to Commit

Increase/Decrease in Active Issues

  • Total active issues now = Open at time of release + Confirmed at time of release + Pending at time of release
  • This number minus the total active as of prior release is the net increase or decrease

As a check, make sure the following formula works:

  • Prior release total active issues + New Reports - (Closed + Fixed in SVN) should equal the Total Active Issues now.