This space is an archive space for documentation related to old versions of Fluid Infusion (i.e. versions before 1.3). For documentation related to the latest Infusion, see Infusion Documentation.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Introduction

About this Page

This document outlines our process for coordinating releases of the Fluid source code and the UX Toolkit.

What's in a Release?

We expect that each Fluid release will contain a combination of framework code, reusable user interface components, and documentation. More specifically:

Technology

  • JavaScript code for the Fluid framework
  • JavaScript, HTML, and CSS for Fluid components
  • Examples and sample code
  • API documentation and tutorials

UX Toolkit

  • UI Design Patterns
  • UX Walkthrough checklists and techniques
  • User testing guidelines
  • Style guides

Frequency of Releases

Fluid intends to release versions of the Fluid framework, components, and UX Toolkit on a roughly quarterly basis. For more information about the specific timing of our releases, check out the Fluid Project 2007-9 Release Plan. The choice to release on a quarterly basis was made in order to:

  • Ensure that we test regularly
  • Regularly produce the important "collateral" material required to successfully use our code:
    • Documentation
    • Quality assurance tests
    • Fixes and work arounds for known issues
  • Provide stable, tested snapshots of our current progress in an easy-to-use form
  • Ease integration with Sakai, uPortal, and our other collaborating projects

Process

As we approach an upcoming release, the following process kicks into gear:

Task

Who Coordinates with the Community?

Identify the Release Manager

Project Manager, Tech Lead

Set the release date and code freeze date

Project Manager, Tech Lead, Release Manager

Coordinate the release deliverables

Project Manager, Tech Lead , UX Leads

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

QA Lead

Recruit QA testers

QA Lead

Create the Release Status page

Release Manager

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

Release Manager

Discuss ongoing bug fixes and commits on fluid-work

Whole Community

Ongoing QA testing and bug fixing

Whole Community

Review commits

Release Manager

Tag and package the release

Release Manager

This is a collaborative process, and the community is encouraged to take an active role in defining schedules and coordinating the release process. It is expected that the Release Manager and QA Lead roles can be rotating positions based on interest and expertise.

About the Release Manager

The Release Manager is a volunteer from the community who agrees to be the primary point of contact for a release. The release manager's responsibilities includes:

  • Working with the technical lead and project manager to determine the timing of a release
  • Announcing the release schedule
  • Coordinating code freeze
    • Reviewing commits
    • Ensuring post-freeze commits are well-tested, filed against known JIRA bugs, and don't change public APIs
  • Managing the mechanics of a release, including:
    • Tagging the release
    • Creating a maintenance branch if necessary
    • Packaging up the release
    • Working with the project manager to announce the release

Release Status

Each Fluid release will have a status page, documenting the deliverables expected for the release. This includes a a list of new functionality, documentation, and the contents of the UX Toolkit. The status page will also outline all of the known bugs and issues that are expected to be fixed in time for the release. The release status page should also include a summary of the goals for the release.

How to Create the Release Status Page

The following summarizes the steps to create a release status page:

  1. In Confluence, create a new wiki page as a child of the Project Coordination page called "Fluid x.y Release Status."
  2. Document the release goals
  3. Create a table outlining the release deliverables, including the status and coordinator for each deliverable
  4. In JIRA, create a filter showing all of the open issues corresponding to the release.
  5. Save the filter and share it publicly. This may require special access in JIRA, so ask if you need help.
  6. Grab the URL to the RSS feed of the filter.
  7. Use the jiraissues tag in Confluence to automatically pull in the contents of the RSS feed and display it in a table:
{jiraissues:http://issues.fluidproject.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?&&pid=10001&resolution=-1&fixfor=10000&sorter/field=priority&sorter/order=DESC&tempMax=100&reset=true&decorator=none
|columns=key;priority;summary;updated;assignee;resolution;status}

Managing Unexpected Issues

Bugs happen. When unexpected issues or problems arise, the Release Manager, Technical Lead, or Project Manager will inform the community and work with them to adjust the release schedule accordingly. If you find an issue that you think is a blocker, let the Release Manager know as soon as possible.

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

  • No labels