Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

We release versions of the Fluid Infusion framework and components on a regular basis. For more information about the contents of each release, check out the Fluid Community Roadmaps.

...

Release Version Number

Each release has a unique version number associated with it, e.g. "0.1" or "0.3beta1". This version number must be recorded consistently in a few locations:

  • git tags (historically SVN tags)
  • Wiki pages and other documentation
  • The project pom.xml and project.xml files
  • The perma-comment at the top of the Fluid.js file
  • The Infusion source code (each .js file - this is not modified for point releases such as 1.3.1)
  • The ImageGallery web/pom.xml file, which has a dependency on Infusion (see Tagging the Source Code for instructions)
  • The ant build scripts properties file, build-scripts/build.properties

...

Task

Who Coordinates with the Community?

Set and announce the release date, code freeze date and bug parade date

Project Manager, Tech Lead, QA Lead

Coordinate the release deliverables and create a roadmap on the wiki

Project Manager, Tech Lead , UX Leads

Review the escalated issues

Whole Team

Create the Release Status wiki page

Release Manager

Ensure known issues in JIRA have been marked with the correct fix version for the release

Whole Team

Create documentation JIRA issues and coordinate with community

Documentation Lead

Work with component design/development teams to produce a test plan for each Fluid component

QA Lead

Recruit QA testers

QA Lead

Create Bug Parade list in JIRA

QA Lead

Coordinate the Bug Parade with the community

QA Lead

Create release related JIRA issues for the main release tasks, and set them as blockers (once Bug Parade is complete)

Release Manager

Coordinate QA and Code Freeze
This includes sending emails to the list announcing Code Freeze.

QA Lead

Coordinate Release Bundle QA

QA Lead

Update JIRA

Release Manager

Write release readme and use it as text for announce e-mail

Release Manager

Write release news item

Release Manager

Manage updating the READ Me

Release Manager

Manage updating the website pages (index, downloads, infusion) with new version number

Release Manager

Manage updating the Wiki

Release Manager

Build, test, and release bundles

Release Manager

Manage git project repo and update code for next Release

Release Manager

Send release annoucement email to sakai-ui, jasig-ue, i-staff@ischool.utoronto.ca, fac-all@ischool.utoronto.ca, i-phd@ischool.utoronto.ca

Release Manager

...

Release Status Wiki Page

Include Page
docsArchive:Creating a Release Status PagedocsArchive:
Creating a Release Status Page

...

Issue Title

Issue #

Issue Description

Code cleanup for release x.x

 

Clean up comments, ensure public APIs are fully commented and JSLint new javascript files.
Note that this issue should only be in force before Code Freeze. Commits that alter actual code should not be permitted during Code Freeze.

Verify dependencies for components

 

This issue should be resolved in bug parade. Look at FLUID-2525 for an example of how to create the jira issue

Check licenses and copyrights

 

Ensure all javascript files have a license and copyright. Copyright should cover only the years since the code file was created and should include only institutions who have made a substantive contribution to the code. Also make sure third party code is compatibly licensed and a license file is included in the same directory as the code. Fluid Licensing

Update and expand on unit test coverage

 

Increase unit test coverage and ensure that all tests are passing.

screen source files for DOS line ending

 

Run source tree through an utility like dos2unix to normalize line endings for Unix. //
Note: this was not done for 1.1. We're going to do it before reopening the trunk.

Turn off debug mode

 

Update fluid.fail() to throw an error, turn off debug mode for the renderer, etc. //
Note: this was not done for 1.1 because fluid.fail() was not turned back on after 1.0. Adding a task to turn fluid.fail() back on before reopening the trunk.

...

  1. Consider putting a disclaimer at the top of any affected pages, with the following text (or something similar):
    • "This page is currently being edited in preparation for the pending X.X release. It's contents should be considered in flux and unreliable until this warning is removed. For the latest stable release, see Fluid Infusion X.X."
  2. Duplicate the old Fluid Infusion - Current Release page into a new page called "Fluid Infusion X.X" where X.X is the old release number.
  3. Update Fluid Infusion - Current Release to the latest release.
    • Be mindful to follow the excerpt format. The links to the bundles at the top will be excerpted, and displayed on the Downloads page.

...

How to Tag and Package the Source Code

Include Page
docsArchive:Creating a Release BundledocsArchive:
Creating a Release Bundle

...

If you discover a security issue, follow the Fluid Security Policy and report the issue privately to the security team.