Versions Compared

Old Version 1

changes.mady.by.user Eli Cochran

Saved on

compared with

New Version Current

changes.mady.by.user Anastasia Cheetham

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Warning

This page is currently being worked on.

Info
titleAbout this Page

This document outlines our process for coordinating releases of the Fluid Infusion source code and the Design Handbook. This is an archival document.

Section
Column
width60%

What's in a Release?

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

Technology

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

Design Handbook

  • UI Design Patterns
  • UX Walkthrough checklists and techniques
  • User testing guidelines
Column
with40%
Panel
borderStyle
borderColor#566b30
bgColor#fff
titleBGColor#D3E3C4
borderStylesolid
titleOn this Pagesolid
Table of Contents
minLevelmaxLevel2
maxLevelminLevel2
excludeIntroduction*

...

Frequency of Releases

We release versions of the Fluid Infusion framework, components, and Design Handbook on a monthly basis. For more information about the contents of each monthly release, check out the Fluid Project 2007-9 Project PlanCommunity 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:

...

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

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

Send release e-mail and create release news item

Release Manager

...

Anchor
statuspage
statuspage

Release Status Wiki Page

Include Page

...

Creating a Release Status Page

...

Creating a Release Status Page

...

Anchor
releasejiras
releasejiras

...

Issue Title

Issue Description

"Tech review of <page> docs"
where <page> may be

  • <component> API
  • <component> Tutorial
  • a framework section, such as Events, Subcomponent, or Renderer
  • etc.

A technical review of <link to actual documentation page>

  • Check page for correctness against current code base:
    • function signatures
    • options (selectors, supported events, styles, etc.)
    • dependencies
    • etc.
  • Check links between pages, add and update where appropriate.

Update the wiki for release

See

http://wiki.fluidproject.org/display/fluid/Release+Process#ReleaseProcess-UpdatingtheWikiforRelease

for details

Update the website for release

See

http://wiki.fluidproject.org/display/fluid/Release+Process#ReleaseProcess-UpdatingDemosontheFluidProjectwebsite

for details

...

  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 and Demos page.
  4. Update the Downloads and Demos page to reflect any new demos that are now available.

Component pages

  1. Go to the Components page
  2. For each Component that was updated in this release, ensure that the relevant information page is updated.
  3. Update API, Integration, Demo, and Testing sections as necessary.

...

  1. House cleaning - Delete any unnecessary design information (pages, notes, etc) added to the Wiki in this past iteration.
  2. Update any Components pages to reflect the current state of the design.
    • Wireframes, Storyboards, Design pattern, Functional Req, User Testing, Story Cards, User modeling, Accessibility.
  3. Verify that any changes to the Design Handbook is reflected.

...

How to Tag and Package the Source Code

Include Page

...

Creating a Release Bundle

...

Creating a Release Bundle

...

Posting the Distribution

The distribution files must be uploaded to the websites releases folder using ftp. Links on the website downloads page (http://fluidproject.org/index.php/download-infusion) and the wiki downloads page will link to this location.

...

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