Projects/SeriesMilestonesReleases/Draft

Not logged in - Log In / Register

Revision 6 as of 2008-03-17 22:54:54

Clear message

DRAFT: this page is a work in progress. Please [:Feedback:seek further help] or check the [:TitleIndex:wiki index] for a complete page on this topic.

ContentsBRTableOfContents

Overview

Let's look at how you can use Launchpad to plan your project's development and to record releases:

Launchpad doesn't impose a particular workflow on your project, so how and whether you use these depends on what value you feel they'll bring.

Series

When we think of the way a project organises itself, there are major lines of development from which releases are "cut". Typically these lines of development represent:

We call each of these "major" lines of development a "series" because they represent a series of releases of the same major version.

In Launchpad, each series behaves almost like a sub-project, having its own:

Let's take a look at the [https://launchpad.net/bzr Bazaar] project as an example.

attachment:bzr-timeline.png

Series in the Bazaar project

Here you can see some of the different lines of development from the Bazaar project:

Creating series

To create a series, provided you're either the project's owner or driver, click Register a series in the Actions menu.

It's up to each project what a series represents and what naming convention they use. For example, in the GNOME project, the "development trunk" is a series with an odd version number, such as 2.17. When it is ready for release, it is branched with an "even" version number, such as 2.18. Once GNOME make the stable release, they branch it to create 2.19, the new "trunk".

Sometimes, projects also call the trunk "MAIN", a term from the days of CVS.

For convention, we encourage you to call your project's development focus "trunk" and to use that same branch for development over time. When creating a new stable series: branch from trunk, create the series and link the branch to that series. This ensures that people who create a checkout of "trunk" don't find that it goes stale because it has later become a stable series.

When you register a series, the description you give it tells other people what your intentions are. If we look at Bazaar's bzr.dev series overview page we can see that it's described as "...the development mainline where new releases are published".

attachment:bzr-sev-series-overviewtimeline.png

The bzr.dev series overview

Over time, a great deal of useful public information about the history of a project becomes associated with its series. That's why, right now, the only way to delete a project series is to [https://answers.launchpad.net/launchpad/+addquestion make a request with the Launchpad admins].

Series goals

As series tend to represent planned releases, it's useful to target bugs and blueprints to particular series. These are called series goals and must be approved by either the project or that series' driver.

[https://edge.launchpad.net/beeseek/ BeeSeek] is a project to create an open source peer to peer search engine. BeeSeek's drivers have marked [https://bugs.launchpad.net/beeseek/+bug/182821 bug 182821] as affecting two of their series, [https://edge.launchpad.net/beeseek/hive Hive] and [https://launchpad.net/beeseek/honeybee Honeybee].

attachment:beeseek-bug.png

Series goal for Hive and Honeybee in BeeSeek

As you can see, this bug has a separate importance, status and assignee in each series. Launchpad excels at tracking how an individual bug affects different communities and contexts; we'll see more of that later.

Anyone can nominate a bug or blueprint as affecting a particular series with the Nominate for release link in the Actions menu. However, only the relevant driver can accept it as series goal.

Milestones

Milestones are specific points during the life of a series, such as:

They're an ideal lightweight way to group a number of bugs and blueprints, optionally targeted to a particular date. Just like series themselves, you can target individual bugs and blueprints to a particular milestone. However, they differ in a couple of important ways:

This is [https://launchpad.net/awn/+milestone/0.4 Avant Window Navigator's 0.4] milestone.

attachment:awn-04.png

Milestone 0.4 for Avant Window Navigator

As you can see, milestones are a really simple way of organising work. Other than a brief description of the milestone's purpose, there's a list of the six blueprints and twenty three bugs targeted to it. Now, everyone working towards AWN 0.4 knows what the release will look like and has the opportunity to volunteer to take some of the work.

Creating a milestone takes no more than clicking Add milestone in the Actions menu for the relevant series. Once the milestone's complete, uncheck Active on its Modify milestone details page. Once deactivated, the milestone no longer appears on your project's overview or milestone pages but it still accessible through its URL.

Releases

attachment:register-a-release.png

Registering a release

While series and milestones help you to plan work that may become a release, they're less useful once you've actually made that release.

You can record the important information about a release, such as its changelog. By registering your releases in Launchpad you can build a public history of your project and make its binaries available for [:Projects/Downloads:download].

Next steps

Now that we've seen how series, milestones and releases fit together, let's [:Projects/Downloads:publish your project's files].