Skip to main content

Release to production

Every project with a repository has a Dev stage, its integration branch, and a Production stage, its production branch (main, or master when the repository has no main). Tasks merge into Dev. A release moves what is on Dev into Production; your CI then deploys it.

You need edit access to the project, unless its pipeline names who may release. A node of your org must be online: Jaah runs the release on one.

On the stage strip, the Release step between two stages is one icon. It animates while a release runs, and its coin shows how many changes wait. Select it to list what waits, with every release action above the list. What each one shows is in Task board › The Release step.

Release​

  1. Select Tasks, then the project in the sidebar. The stage strip sits under the top line.
  2. Select the Release step between Dev and Production.
  3. The list shows only the waiting tasks, none ticked. The row above them shows how many will ship, the commits with no task (+N), their cost, their tokens and how long the oldest has waited; hover a figure for its words. With none ticked, everything ships. To hold some back, tick only the tasks that should ship; the commits with no task then stay behind.
  4. Leave When at Now, then select Release N, where N is the number of changes that will ship. It sends at once, with no confirmation.
  5. Watch the Release step and the Production block. Once the release succeeds, Production shows the new version.

Run opens the page of the release's run, with its jobs and logs. Cancel withdraws the release before it merges. It asks first, Cancel this release?, since its changes go back to waiting. Select Cancel release, or Keep it to let it run.

Schedule a release​

With the Release step selected, select the clock in When and pick a time. Select Release N. It is scheduled at once. The row shows a Scheduled chip with the time.

Release changes that have not been tested​

With the merge lane on, changes merged after its newest tested commit wait for tests. They are not listed. If you can edit the pipeline, a release with nothing ticked ships them too, and Release N counts them. See Release changes that have not been tested.

Approvals and freezes​

When the step needs approvals, its row shows how many it has, such as 0/1 approvals, and each person who may approve sees Approve. The person who asked for the release never can. During a freeze it reads Frozen until a time, and a release can be scheduled for when it ends. Approvals, freezes, who may release and whether a release runs by itself are set in the project's Settings › CI Pipeline: see Set up a project's pipeline.

Why a step waits​

A step with something waiting ends with a chip naming the first thing that holds it, such as 0/2 approvals, Frozen, Soak 42m, Off hours or Paused. Hover or tap the chip for every reason, one per line. The same chip sits above a step's waiting list. The reasons:

  • Approvals: how many it has of how many it needs, such as 1/3 approvals; who may approve; who approved, with their comment; and Your approval counts or You asked for this for you. Whoever asked for the step can't approve it.
  • For approvers: the instructions the step gives its approvers.
  • Cancels in or Reminder in: the time left before an unanswered approval runs out.
  • Ready in: the wait (soak) after the previous step before this one may run.
  • Next allowed: the next allowed hour, in the step's own timezone, such as Mon 09:00 (Europe/Berlin).
  • Frozen until: a freeze covering the step now. Freeze starts warns of one starting within 7 days.
  • Frozen now by: someone switched on Freeze now, which holds every release at once. While it is on, a Frozen now banner above the list names who switched it on and when.
  • Sign-off: how many tasks still need sign-off before the step may run.
  • Verifying, Verify failed or Not verified: the previous stage's checks after arrival have not passed yet, such as Verifying Dev — 0 of 1 gates passed.
  • Runs after: one release at a time; this one runs after the named release finishes.
  • By itself paused after hotfix: a release pressed by hand went ahead of the normal path, such as a pick of some changes; the step's automatic run waits until the normal path catches up.

A freeze can be overridden for one release by whoever may release and edit the pipeline. While a freeze holds the step, When opens at the freeze's end. Select the clock to switch it to Now, then select Release N. It runs through the freeze at once. The Audit page records the override with No reason given. A queued or scheduled release held by a freeze shows its own Override button, which runs it through the same way. Every rule is set in the project's Settings › CI Pipeline: see Set up a project's pipeline.

When a release fails​

With the Release step selected, the row shows Run when the deploy has a page, and Checks before Production below it lists the step's checks. To try again, select Release: it sends everything still waiting. While no node is online, a queued release shows Open nodes. A queued release that can't start turns orange; hover it for why. If it still hasn't started after 5 minutes, it fails with that reason. While the project's deploys are not tracked, Connect deploys opens the setting that tracks them, so a release finishes when its deploy does.

To check what a release did to production, see Check whether a release broke production. The merge lane, when on, merges each release too: see Use the merge lane.