Docs

Releases

What this screen is for

A release is a set of components going to an environment together, with its notes, its linked work, its approvals and its execution history in one place.

Before you start

To do this You need
See releases deployment-manager.access
Open one deployment-manager.release.view.details
Create one deployment-manager.release.create
Use quick actions deployment-manager.release.view.details.quick-actions
Sign one off deployment-manager.release.signoff
Delete your own deployment-manager.release.delete
Delete anyone’s deployment-manager.release.admin-delete

Configure environments and sign-off roles first — see Configuration.

Opening it

  • List: /deployment-manager/releases
  • Create: /deployment-manager/releases/create
  • One release: /deployment-manager/releases/:id

The interface

📸 Screenshot Placeholder: A release details page on the Overview tab. Mark: (1) the tab bar, (2) the release status, (3) the quick actions, (4) the link to the MEP runbook.

Release details has up to seven tabs:

Tab What it shows
Overview Status, target, and what the release contains
Requests The change requests in the release
Release Notes The notes, from your configured template
Pull Requests Linked PRs — only when the integration is enabled
Jira Issues Linked issues — only when Jira is connected
Deployments What was deployed, where
Execution History Runbook runs — the same body as MEP Runbook
Full Timeline Everything, in order

The Pull Requests and Jira Issues tabs are absent unless those integrations are configured. Their absence is a configuration state, not a permission problem — see Settings › Development › Integrations.

The creation wizard

Step What it does Present when
Select System Chooses the system, and the release’s version and name Always — later steps build on it
Jira Integration Links Jira issues Only when Jira is enabled
Configure Components Chooses components and their CI type (e.g. Argo Workflows) Always
Release Notes Fills the notes Always
Review & Create Final check Always

Walkthroughs

Create a release

Requires deployment-manager.release.create.

  1. Deploy › Deployments › Releases, click create.
  2. Select System — pick the system, then set the version and name. Get this right: every later step builds on it.
  3. Jira Integration, if shown — select the issues. If the system has no Jira project configured, the step says so and you can continue without it.
  4. Configure Components — choose what is going out and confirm each component’s CI type.
  5. Release Notes — fill them from the template.
  6. Review & Create.

Sign off a release

Requires deployment-manager.release.signoff.

Open the release and sign off. Who must sign is set in Configuration › Release Sign-offs.

Delete a release

release.delete covers your own. Removing someone else’s needs release.admin-delete — a deliberately separate permission, because deleting a release destroys the record of what shipped.

Scenario

A release is half-executed and someone asks “what actually went out?”

This is exactly what the record exists for, so resist the urge to check the cluster first.

  1. Open the release. Overview gives you status and target.
  2. Deployments tab — what was deployed and where. This is the authoritative answer to the question asked.
  3. Execution History — how far the runbook got, and where it stopped.
  4. Full Timeline — the sequence, including anything done out of band.
  5. Only now compare against reality in Production’s Events tab. If they disagree, someone acted directly on the environment, and the discrepancy itself is the finding worth reporting.
  6. Decide from the runbook state — resume or abort — rather than by acting on the environment. Acting outside the runbook makes the record wrong for the next person who asks this question.

When it doesn’t work

Symptom Cause How to check Fix
Pull Requests or Jira tab missing That integration is not enabled Settings › Development › Integrations Connect it, or accept the tab’s absence
Jira step says the system has no Jira project No project mapped for that system The wizard message Map the project, or continue without
Cannot open a release access without release.view.details Access Explorer Ask for the details permission
Quick actions absent Missing release.view.details.quick-actions Access Explorer Ask for it — it is separate from viewing
Cannot delete someone else’s release Needs release.admin-delete Access Explorer Deliberately separate; request explicitly
Release says deployed, environment disagrees Someone acted directly on the environment The environment’s Events tab Reconcile here so the record stays true

Next