About this Page
This document outlines our process for coordinating releases of the Fluid source code and the UX Toolkit.
The user manual for the Fluid packaged software releases consists of a set of information pages residing in the Fluid wiki. This Table of Contents lists all of the manual pages, organized under section headings. You can navigate through the manual by following the links below. To return to this page, click the link labelled User Manual ToC at the top of the left-side navigation bar.
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:
- Examples and sample code
- API documentation and tutorials
- UI Design Patterns
- UX Walkthrough checklists and techniques
- User testing guidelines
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 Project 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:
- 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
Resease Version Number
Each release must have 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:
- Wiki pages and other documentation
- The project
antbuild scripts properties file,
- The version number of the Wiki API page snapshots
The following instructions will describe more specifically when, where and how to record the release number.
As we approach an upcoming release, the following process kicks into gear:
Who Coordinates with the Community?
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
Recruit QA testers
Tech Lead, UX Leads
Ensure known issues in JIRA have been marked with the correct fix version for the release
Discuss ongoing bug fixes and commits on fluid-work
Ongoing QA testing and bug fixing
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
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:
- In Confluence, create a new wiki page as a child of the Project Coordination page called "Fluid x.y Release Status" (where x.y is the version number).
- Document the release goals
- Create a table outlining the release deliverables, including the status and coordinator for each deliverable
- In JIRA, create a filter showing all of the open issues corresponding to the release.
- Save the filter and share it publicly. This may require special access in JIRA, so ask if you need help.
- Grab the URL to the RSS feed of the filter.
- Use the jiraissues tag in Confluence to automatically pull in the contents of the RSS feed and display it in a table:
Updating the Wiki for Release
Updating Wiki: Development
- Update any development API and integration pages.
- Update any demos
- House cleaning - Delete any unnecessary pages and information created in this past iteration.
- Update download & component pages (see below)
Release download pages
- 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.
- _This new page should be a child of Fluid Infusion - Current Release.
- Update Fluid Infusion - Current Release to the latest release.
- Be mindful to follow the excerpt format
- Update the Downloads and Demos page to reflect any new demos that are now available.
- Go to the Components page
- For each Component that was updated in this release, ensure that the relevant information page is updated.
- Update API, Integration, Demo, and Testing sections as necessary.
Updating Wiki: UX
- House cleaning - Delete any unnecessary design information (pages, notes, etc) added to the Wiki in this past iteration.
- 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.
- Verify that any changes to the UX Toolkit is reflected.
How to Create a Snapshot of the Wiki API Pages
How to Tag and Package the Source Code
How to Tag the Source Code
Note that the Fluid-0.1 release is used as an example in what follows. If you are using these instructions for another release, remember to substitute the correct version number for occurrences of "0.1".
The steps to tag the source code are:
- Impose a source code repository freeze until the source code is tagged. Announce the freeze on the fluid-work mailing list (email@example.com).
- Users are prohibited from committing to the source code repository trunk while the tagging operation is under way.
- Modify the release information in the necessary files:
- Edit the maven project file(s) (
- Set the contents of the
<version>tags as appropriate, for example:
- Edit the ant properties file(s) (
- Set the contents of the
<version>tag as appropriate, for example:
- Commit these project files to the repository.
- Edit the maven project file(s) (
- Check out a fresh, clean working copy of the source code from the trunk.
- Using this working copy, ensure that the build works.
- In the
- The build should create a war file containing the fluid components. The war file is created in
.../fluid-0.1/target/fluid-components-0.1.war, and is copied to the local maven 2 repository,
- In the
- Run the jqUnit tests (by opening the HTML test files in a browser), and ensure that all succeed.
- Tag the source with the release version number.
- Note that the above assumes that "fluid-0.1" is the directory containing the maven project file with the correct release version tag.
- Modify the version of the maven and ant project files (
build-scripts/build.properties) on trunk to reflect that trunk development is now a snapshot of the next release version. For example:
- Commit the trunk's modified maven project file.
- Lift the prohibition of committing to the trunk of the repository by announcing same on the fluid-work mailing list (firstname.lastname@example.org).
How to Package the Source Code
The steps to package the source code are:
- Check out a fresh, clean copy of the tagged version of the source code.
cdinto the build scripts folder (
fluid-0.1/build-scripts) and run the
anttask to build the release bundle: This creates a folder called
productsand places the release bundles there:
- This zip file should contain the license files, as well as source, examples, and the war file.
- Test the distribution file thoroughly by unpacking it into a clean environment and running all tests, etc.
Posting the Distribution
- Mark the version released, moving remaining open issues to the next version.
- Do a query for all unresolved issues that affect the previous release and release candidates. Add the new release version as an affected version for each issue in the results.
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.