ForgeboardGuide
/
Sign in

Releases and milestones

Group issues into a version with a target date, ship it, and generate its release notes.

Project → Releases

A release groups the issues that ship together under a name, an optional version and a target date. Mark it shipped when it goes out, and copy its release notes, which are built from the issues it contains.

Open releases

Open a project and choose the Releases tab. Along the top: Total, Planned, Shipped, and Issues with how many are done.

The Milestones tab is the same list under another name. A milestone and a release are the same record, so use whichever word suits your team.

Create a release

  1. Choose New release.
  2. Fill in the Name. The other fields are optional: Version (for example v1.0.0), Target date and Description.
  3. Choose Create.

To change these later, choose Edit release from the release's ... menu.

Add issues

  • Choose Add issues on the release, or from its menu. Search by key or title, tick the issues and choose Add. The picker only lists issues that aren't in a release yet, and leaves out sub-issues.
  • Or open an issue and set its Release field.
  • To take an issue out, hover over its row and choose the cross.

An issue belongs to at most one release at a time.

Status, progress and forecast

  • A release is Planned until you mark it shipped, then Shipped with its ship date.
  • Its progress is the share of its issues in a done status.
  • While it is planned, a forecast line shows how much work is left and when it is likely to be done, at 50%, 85% and 95% confidence. It replays the project's last ten completed sprints. With a target date, it also says whether it is on track for the target or likely to miss it, based on the 85% date. The forecast needs at least three completed sprints in the project.

Ship a release

Choose Ship. The release is marked shipped today. A RELEASE_SHIPPED event goes to any outbound webhooks you have set up, and the release appears in the changelog of the public roadmap if that page is on and the project is public.

Release notes

Choose Notes to see release notes made from the release's issues, grouped by type: stories under Features, tasks under Improvements, bugs under Bug fixes, then epics. Each line shows the issue key, title and assignee, and the release's description goes at the top.

Copy Markdown copies the notes, ready to paste into a changelog or announcement. Markdown source shows the text first. The notes are always generated, never typed in, so rename an issue to change its line.

Delete a release

Delete release removes the release. Its issues are kept; they just stop belonging to a release. This can't be undone.

Related