Release management
Every Release management tool, with the scope it needs, its arguments and the API operation it calls.
38 tools
List release activity
Read onlyatlas_releases_activity_list
List the history of a release, newest first: status changes, scope changes, checks, approvals, deployments and notes.
- Scope
releases:read- Calls
- Example prompt
- What has changed on release 2.4.0 this week?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
limit | integer | No | How many rows to return, 1 to 100. 50 by default. |
cursor | string | No | The nextCursor of the previous page. Leave it out for the first page. |
sort | "createdAt" | No | The field to sort on: createdAt. createdAt by default. |
order | "asc" | "desc" | No | asc or desc. desc by default. |
Decide release approvals
Changes dataatlas_releases_approvals_decide
Record the decision on an approval request: APPROVED or REJECTED, with an optional comment. Only the person who was asked may decide. The release owner is notified.
- Scope
releases:write- Calls
- Example prompt
- Approve release 2.4.0 with the comment: tests are green.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
approvalId | string | Yes | The approval id. Only the named approver may decide it. |
decision | "APPROVED" | "REJECTED" | Yes | APPROVED or REJECTED. |
comment | string | null | No | An optional comment recorded with the decision. |
Request release approvals
Changes dataatlas_releases_approvals_request
Ask people to approve a release. Each named person other than the caller receives a notification and may then approve or reject. Asking a person again resets their earlier decision to pending. A Released or Cancelled release refuses new requests.
- Scope
releases:write- Calls
- Example prompt
- Ask Priya and Marcus to sign off on release 2.4.0.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
approverIds | array of string | Yes | The people asked to approve the release. Each one is notified. |
Withdraw release approvals
Destructiveatlas_releases_approvals_withdraw
Withdraw an approval request that is still pending, so the person is no longer asked.
- Scope
releases:write- Calls
- Example prompt
- Withdraw the sign-off request I sent to Marcus.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
approvalId | string | Yes | The approval id. |
Get release calendar
Read onlyatlas_releases_calendar_get
Return the release calendar for a range of at most 366 days: the releases with their target and released days, and the freeze windows. The truncated flag is true when the range holds more releases than one response carries.
- Scope
releases:read- Calls
- Example prompt
- Which days in November are free for a release?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | The first day to show. |
to | string | Yes | The last day to show. At most 366 days after the first. |
Add release checks
Changes dataatlas_releases_checks_add
Add a readiness check to a release, such as a security review or a documentation sign-off. A required check that is not done blocks the move to RELEASED.
- Scope
releases:write- Calls
- Example prompt
- Add a required security review check to release 2.4.0.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
title | string | Yes | What must be true before release. |
category | "QUALITY" | "SECURITY" | "DOCUMENTATION" | "OPERATIONS" | "COMMUNICATION" | "OTHER" | No | The kind of check. OTHER by default. |
required | boolean | No | Whether an unmet check blocks the move to RELEASED. True by default. |
position | integer | No | Where the check sits in the list. |
Delete release checks
Destructiveatlas_releases_checks_delete
Delete a readiness check from a release by id. A Released or Cancelled release refuses checklist changes.
- Scope
releases:write- Calls
- Example prompt
- Remove the optional communication check from release 2.4.0.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
checkId | string | Yes | The check id. |
Update release checks
Changes dataatlas_releases_checks_update
Change a readiness check: its title, category, whether it is required, its position, or whether it is done. Send only the fields to change.
- Scope
releases:write- Calls
- Example prompt
- Mark the documentation check on release 2.4.0 as done.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
checkId | string | Yes | The check id. |
title | string | No | A new title. |
category | "QUALITY" | "SECURITY" | "DOCUMENTATION" | "OPERATIONS" | "COMMUNICATION" | "OTHER" | No | A new category. |
required | boolean | No | Whether the check blocks the move to RELEASED. |
position | integer | No | A new position in the list. |
done | boolean | No | Mark the check done or not done. |
Create releases
Changes dataatlas_releases_create
Create a release in the PLANNED status, from scratch or from a template (templateId). Without a template a name is required. The version, type, days, owner and project are optional and win over the template. A moratorium at FREEZE_ALL refuses the call with 409; a weaker one is returned as a warning in the moratorium field. Returns the new release. Idempotent per call.
- Scope
releases:write- Calls
- Example prompt
- Create a minor release called Spring 2.5 targeting 30 November.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
templateId | string | No | Start from a template (see atlas_releases_templates_list). The template supplies the name, the version bumped from the latest released version, the type, the dates, the checklist, the environment pipeline and a notes outline. Every field you send wins over the template. |
name | string | No | The release name, 1 to 120 characters. Required unless a template is given. |
version | string | null | No | A semantic version such as 1.4.0 or a calendar version such as 2026.10. Leave out for none. |
type | "MAJOR" | "MINOR" | "PATCH" | "HOTFIX" | No | MAJOR, MINOR, PATCH or HOTFIX. The template type, else MINOR, by default. |
description | string | null | No | What the release delivers. |
startDate | string | null | No | The day work starts. |
targetDate | string | null | No | The day the release is planned to ship. Not before the start day. |
ownerId | string | null | No | The person who owns the release. |
projectId | string | null | No | The project the release belongs to. |
Delete releases
Destructiveatlas_releases_delete
Delete a release by id. Only the release owner or a workspace owner or administrator may do so, and a release that has been released cannot be deleted. The tasks in its scope are not touched. This cannot be undone through the API.
- Scope
releases:write- Calls
- Example prompt
- Delete the draft release called Experiment.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
Delete release deployments
Destructiveatlas_releases_deployments_delete
Remove a deployment that is still PLANNED, such as an environment a template added that this release does not go to. A deployment that started or finished stays in the record and is refused with 409 (release-deployment-not-planned). A Cancelled release refuses the change.
- Scope
releases:write- Calls
- Example prompt
- Remove the planned Staging deployment from release 2.4.0.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
deploymentId | string | Yes | The deployment id. |
List release deployments
Read onlyatlas_releases_deployments_list
List the deployments recorded for a release, one per environment attempt, with status and times.
- Scope
releases:read- Calls
- Example prompt
- Where has release 2.4.0 been deployed so far?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
Record release deployments
Changes dataatlas_releases_deployments_record
Record a deployment of a release to an environment, with its status, times, notes and an optional linked incident. A Cancelled release refuses new deployments. A moratorium that blocks deploying to the environment refuses it with 409, judged at the scheduled time for a PLANNED deployment and at now otherwise.
- Scope
releases:write- Calls
- Example prompt
- Record a successful deployment of release 2.4.0 to Staging.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
environment | string | Yes | The environment, such as Staging or Production. |
status | "PLANNED" | "IN_PROGRESS" | "SUCCEEDED" | "FAILED" | "ROLLED_BACK" | No | PLANNED by default. |
scheduledAt | string (date-time) | null | No | When the deployment is scheduled, an ISO 8601 time with an offset. |
startedAt | string (date-time) | null | No | When the deployment started. |
finishedAt | string (date-time) | null | No | When the deployment finished. Not before it started. |
notes | string | null | No | Notes about the deployment. |
incidentId | string | null | No | An incident this deployment caused or answered. |
Update release deployments
Changes dataatlas_releases_deployments_update
Change a recorded deployment: its environment, status, times, notes or linked incident. Send only the fields to change.
- Scope
releases:write- Calls
- Example prompt
- Mark the Production deployment of release 2.4.0 as failed.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
deploymentId | string | Yes | The deployment id. |
environment | string | No | A new environment name. |
status | "PLANNED" | "IN_PROGRESS" | "SUCCEEDED" | "FAILED" | "ROLLED_BACK" | No | A new deployment status. |
scheduledAt | string (date-time) | null | No | When the deployment is scheduled, an ISO 8601 time with an offset. |
startedAt | string (date-time) | null | No | When the deployment started. |
finishedAt | string (date-time) | null | No | When the deployment finished. Not before it started. |
notes | string | null | No | Notes about the deployment. |
incidentId | string | null | No | An incident this deployment caused or answered. |
Decide release exceptions
Changes dataatlas_releases_exceptions_decide
Approve or reject an exception to a moratorium, with an optional note. Only a workspace owner or administrator may, and never the person who asked; a decided exception is refused with 409.
- Scope
releases:write- Calls
- Example prompt
- Approve the exception for the payments hotfix.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
exceptionId | string | Yes | The exception id. |
decision | "APPROVED" | "REJECTED" | Yes | APPROVED or REJECTED. |
note | string | null | No | An optional note recorded with the decision. |
List release exceptions
Read onlyatlas_releases_exceptions_list
List the exceptions to moratoriums asked for one release, newest first, with their status and decision.
- Scope
releases:read- Calls
- Example prompt
- Which exceptions were asked for the billing release?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
Request release exceptions
Changes dataatlas_releases_exceptions_request
Ask for an exception that lets one release through one moratorium, with the reason it cannot wait. Once approved, the moratorium warns about the release instead of blocking it. A request already pending or approved is refused with 409; a rejected one is reopened.
- Scope
releases:write- Calls
- Example prompt
- Ask for an exception to the Diwali freeze for the payments hotfix.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
moratoriumId | string | Yes | The moratorium to let this release through. |
reason | string | Yes | Why the release cannot wait for the moratorium to end. |
Search release exceptions
Read onlyatlas_releases_exceptions_search
List the exceptions to moratoriums across the workspace, newest first, optionally only those in one status. PENDING gives the queue waiting for a workspace owner or administrator to decide.
- Scope
releases:read- Calls
- Example prompt
- Which moratorium exceptions are waiting for a decision?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
status | "PENDING" | "APPROVED" | "REJECTED" | No | Only exceptions in this status, such as PENDING for the ones waiting for a decision. |
Create release freezes
Changes dataatlas_releases_freezes_create
Create a moratorium (release freeze window). Give the window as startLocal and endLocal in timeZone, or as the instants startsAt and endsAt. Set the enforcement level, a recurrence (yearly for a holiday, weekly for weekends), the environments and projects it covers, and release types it lets through. While it is in force the API refuses what the level blocks with 409, and no override lifts it: only an approved exception (atlas_releases_exceptions_request) or an allowed type does. Workspace owners and administrators only.
- Scope
releases:write- Calls
- Example prompt
- Freeze Production from 20 December to 3 January for the holidays.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The moratorium name. |
startLocal | string | No | When the moratorium begins, as local wall time in timeZone, YYYY-MM-DDTHH:mm. |
endLocal | string | No | When it ends, as local wall time in timeZone. After it begins. |
timeZone | string | No | The IANA time zone the window is written in, such as Asia/Kolkata. UTC by default. |
startsAt | string (date-time) | No | The older way to give the start: an instant with an offset, read as wall time in timeZone. |
endsAt | string (date-time) | No | The older way to give the end: an instant with an offset. |
description | string | null | No | Why the moratorium exists. |
reason | string | null | No | The same text as description, under its older name. |
reasonCategory | "HOLIDAY" | "FESTIVAL" | "SALE" | "PEAK_TRAFFIC" | "STAFFING" | "COMPLIANCE" | "INCIDENT_RECOVERY" | "OTHER" | No | The kind of moratorium. OTHER by default. |
enforcement | "WARN" | "BLOCK_DEPLOYMENTS" | "BLOCK_RELEASES" | "FREEZE_ALL" | No | WARN blocks nothing; BLOCK_DEPLOYMENTS refuses recording a deployment; BLOCK_RELEASES also refuses moving a release to RELEASED; FREEZE_ALL also refuses creating a release. BLOCK_RELEASES by default. |
recurrence | "NONE" | "YEARLY" | "WEEKLY" | No | NONE, YEARLY or WEEKLY. NONE by default. |
environments | array of string | No | The environments whose deployments it covers. Empty means every environment. Production by default. |
projectIds | array of string | No | The projects it covers. Empty means every project. |
allowedReleaseTypes | array of "MAJOR" | "MINOR" | "PATCH" | "HOTFIX" | No | Release types let through with a warning instead of a refusal, such as HOTFIX. |
active | boolean | No | False keeps the moratorium but enforces nothing. |
Delete release freezes
Destructiveatlas_releases_freezes_delete
Delete a moratorium, together with every exception asked of it. It no longer warns about or blocks anything.
- Scope
releases:write- Calls
- Example prompt
- Remove the year end release freeze.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The moratorium id. |
List release freezes
Read onlyatlas_releases_freezes_list
List the moratoriums (release freeze windows) of the workspace: each with its wall-clock window and time zone, recurrence, enforcement level, environments, projects and allowed release types, whether it is in force now, and its current and next occurrence.
- Scope
releases:read- Calls
- Example prompt
- Are any release freezes coming up?
Arguments
This tool takes no arguments.
Update release freezes
Changes dataatlas_releases_freezes_update
Change a moratorium: its name, window, time zone, recurrence, level, environments, projects, allowed types or whether it is enabled. Send only the fields to change. Workspace owners and administrators only.
- Scope
releases:write- Calls
- Example prompt
- Extend the year end freeze by two days.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The moratorium id. |
name | string | No | A new name. |
startLocal | string | No | When the moratorium begins, as local wall time in timeZone, YYYY-MM-DDTHH:mm. |
endLocal | string | No | When it ends, as local wall time in timeZone. After it begins. |
timeZone | string | No | The IANA time zone the window is written in, such as Asia/Kolkata. UTC by default. |
startsAt | string (date-time) | No | The older way to give the start: an instant with an offset, read as wall time in timeZone. |
endsAt | string (date-time) | No | The older way to give the end: an instant with an offset. |
description | string | null | No | Why the moratorium exists. |
reason | string | null | No | The same text as description, under its older name. |
reasonCategory | "HOLIDAY" | "FESTIVAL" | "SALE" | "PEAK_TRAFFIC" | "STAFFING" | "COMPLIANCE" | "INCIDENT_RECOVERY" | "OTHER" | No | The kind of moratorium. OTHER by default. |
enforcement | "WARN" | "BLOCK_DEPLOYMENTS" | "BLOCK_RELEASES" | "FREEZE_ALL" | No | WARN blocks nothing; BLOCK_DEPLOYMENTS refuses recording a deployment; BLOCK_RELEASES also refuses moving a release to RELEASED; FREEZE_ALL also refuses creating a release. BLOCK_RELEASES by default. |
recurrence | "NONE" | "YEARLY" | "WEEKLY" | No | NONE, YEARLY or WEEKLY. NONE by default. |
environments | array of string | No | The environments whose deployments it covers. Empty means every environment. Production by default. |
projectIds | array of string | No | The projects it covers. Empty means every project. |
allowedReleaseTypes | array of "MAJOR" | "MINOR" | "PATCH" | "HOTFIX" | No | Release types let through with a warning instead of a refusal, such as HOTFIX. |
active | boolean | No | False keeps the moratorium but enforces nothing. |
Get releases
Read onlyatlas_releases_get
Return one release by id: its details, status, owner, project, scope counts, readiness and blockers, any active freeze, checks, approvals and deployments.
- Scope
releases:read- Calls
- Example prompt
- Show me the readiness of release 2.4.0.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
Add release items
Changes dataatlas_releases_items_add
Add tasks to the scope of a release by task id, up to 2000 at a time. Tasks already in scope are counted, not added twice. Returns the number added, the number already in scope and the new scope counts. A task that does not exist, or that the caller cannot read, stops the whole request. A Released or Cancelled release refuses scope changes.
- Scope
releases:write- Calls
- Example prompt
- Add these five tasks to release 2.4.0.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
taskIds | array of string | Yes | The tasks to add to the release scope. Tasks already in scope are ignored. |
List release items
Read onlyatlas_releases_items_list
List the tasks in the scope of a release with their live status, plus the total and the number hidden from the caller by access rules.
- Scope
releases:read- Calls
- Example prompt
- Which tasks are in release 2.4.0?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
Remove release items
Destructiveatlas_releases_items_remove
Take one task out of the scope of a release. The task itself is not deleted.
- Scope
releases:write- Calls
- Example prompt
- Take the login redesign task out of release 2.4.0.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
taskId | string | Yes | The task to take out of the release scope. |
List releases
Read onlyatlas_releases_list
List the releases of the workspace, newest first, with status, version, target day, scope counts and readiness. Filter by status, project, owner, name text and target day range. Returns a page and a nextCursor.
- Scope
releases:read- Calls
- Example prompt
- Which releases are planned for this month?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
limit | integer | No | How many rows to return, 1 to 100. 50 by default. |
cursor | string | No | The nextCursor of the previous page. Leave it out for the first page. |
sort | "createdAt" | "updatedAt" | "name" | No | The field to sort on: createdAt, updatedAt, name. createdAt by default. |
order | "asc" | "desc" | No | asc or desc. desc by default. |
status | array of "PLANNED" | "IN_PROGRESS" | "READY" | "RELEASED" | "ON_HOLD" | "CANCELLED" | "ROLLED_BACK" | No | Only releases in one of these statuses. |
projectId | string | No | Only releases linked to this project. |
ownerId | string | No | Only releases owned by this person. |
q | string | No | Text to find in the release name. |
targetFrom | string | No | Only releases with a target day on or after this day. |
targetTo | string | No | Only releases with a target day on or before this day. |
Check release moratoriums
Read onlyatlas_releases_moratoriums_check
Ask what the moratoriums would do to an action before taking it: CREATE_RELEASE, RELEASE or DEPLOY. Returns the outcome (ALLOW, WARN or BLOCK) and each moratorium that applies, with its level and window, and whether an allowed type or an approved exception turned a block into a warning.
- Scope
releases:read- Calls
- Example prompt
- Can we deploy to Production on 24 December?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
action | "CREATE_RELEASE" | "RELEASE" | "DEPLOY" | Yes | The action to judge: creating a release, moving one to RELEASED, or recording a deployment. |
releaseId | string | No | The release the action is about. Its project, type and exceptions are then used. |
environment | string | No | For DEPLOY, the environment deployed to. |
at | string (date-time) | No | When the action would happen. Now by default. |
projectId | string | No | For CREATE_RELEASE, the project the new release would belong to. |
releaseType | "MAJOR" | "MINOR" | "PATCH" | "HOTFIX" | No | For CREATE_RELEASE, the type of the new release. |
Generate release notes
Changes dataatlas_releases_notes_generate
Draft release notes in Markdown from the finished tasks in the release scope, grouped by kind. Nothing is saved or published: pass the draft to atlas_releases_notes_save.
- Scope
releases:write- Calls
- Example prompt
- Draft release notes for 2.4.0 from the finished tasks.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
Publish release notes
Changes dataatlas_releases_notes_publish
Publish the saved release notes inside the workspace, so they are read as final.
- Scope
releases:write- Calls
- Example prompt
- Publish the release notes for 2.4.0.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
Save release notes
Changes dataatlas_releases_notes_save
Save the release notes as Markdown, replacing the earlier text. Saving withdraws an earlier publication, so what is published is always what was reviewed.
- Scope
releases:write- Calls
- Example prompt
- Save these as the release notes for 2.4.0.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
notesMarkdown | string | Yes | The release notes as Markdown, up to 50000 characters. Saving withdraws any earlier publication. |
Create release templates
Changes dataatlas_releases_templates_create
Create a custom release template: name, description, category, release type, version bump, name pattern, duration in days, environment pipeline, checklist and notes outline. Any member may create one. A name already used in the workspace is refused with 409.
- Scope
releases:write- Calls
- Example prompt
- Make a template for our fortnightly payments release.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The template name, unique in the workspace. |
description | string | null | No | What the template is for. |
category | "STANDARD" | "HOTFIX" | "MAJOR_LAUNCH" | "MOBILE" | "INFRASTRUCTURE" | "SECURITY" | "COMPLIANCE" | "DATA_MIGRATION" | "FEATURE_FLAG" | "MARKETING_LAUNCH" | No | The kind of release the template plans. STANDARD by default. |
releaseType | "MAJOR" | "MINOR" | "PATCH" | "HOTFIX" | No | The type of a release made from it. MINOR by default. |
versionBump | "major" | "minor" | "patch" | "calendar" | "none" | No | How the version moves on from the latest released one: major, minor, patch, calendar or none. |
namePattern | string | No | The name of a release made from it. Tokens: {year} {month} {quarter} {week} {version}. |
durationDays | integer | No | Days from the start day to the target day. |
environments | array of string | No | The deployment pipeline, in order. Each environment once. |
checks | array of object | No | The readiness checklist a release made from it starts with. |
notesSections | array of string | No | The headings of the release notes outline. |
Delete release templates
Destructiveatlas_releases_templates_delete
Delete a custom release template. Releases made from it keep everything they were given. Only its author or a workspace owner or administrator may; a built-in template is refused with 409.
- Scope
releases:write- Calls
- Example prompt
- Delete the old mobile template.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | A template id: builtin:<key> for a built-in template, or the id of a custom template. |
List release templates
Read onlyatlas_releases_templates_list
List the release templates: the ten built-in ones (standard, hotfix, major launch, mobile app, infrastructure, security patch, regulated, data migration, feature flag, marketing launch) and the custom ones of the workspace, each with its type, version bump, duration, pipeline and checklist. Also returns latestReleasedVersion, the version a template bumps from.
- Scope
releases:read- Calls
- Example prompt
- Which release templates can I start from?
Arguments
This tool takes no arguments.
Save release templates
Changes dataatlas_releases_templates_save
Save a release as a custom template: its checklist, the environments it was deployed to, its type, its length in days and the headings of its notes. Returns the new template.
- Scope
releases:write- Calls
- Example prompt
- Save the autumn release as a template.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
name | string | No | The template name. The release name followed by "template" by default. |
description | string | null | No | What the template is for. |
category | "STANDARD" | "HOTFIX" | "MAJOR_LAUNCH" | "MOBILE" | "INFRASTRUCTURE" | "SECURITY" | "COMPLIANCE" | "DATA_MIGRATION" | "FEATURE_FLAG" | "MARKETING_LAUNCH" | No | The kind of release the template plans. STANDARD by default. |
versionBump | "major" | "minor" | "patch" | "calendar" | "none" | No | How the version moves on from the latest released one: major, minor, patch, calendar or none. |
namePattern | string | No | The name of a release made from it. Tokens: {year} {month} {quarter} {week} {version}. |
Update release templates
Changes dataatlas_releases_templates_update
Change a custom release template. Send only the fields to change. Only its author or a workspace owner or administrator may; a built-in template is refused with 409.
- Scope
releases:write- Calls
- Example prompt
- Add a security review to the payments template.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | A template id: builtin:<key> for a built-in template, or the id of a custom template. |
name | string | No | The template name, unique in the workspace. |
description | string | null | No | What the template is for. |
category | "STANDARD" | "HOTFIX" | "MAJOR_LAUNCH" | "MOBILE" | "INFRASTRUCTURE" | "SECURITY" | "COMPLIANCE" | "DATA_MIGRATION" | "FEATURE_FLAG" | "MARKETING_LAUNCH" | No | The kind of release the template plans. STANDARD by default. |
releaseType | "MAJOR" | "MINOR" | "PATCH" | "HOTFIX" | No | The type of a release made from it. MINOR by default. |
versionBump | "major" | "minor" | "patch" | "calendar" | "none" | No | How the version moves on from the latest released one: major, minor, patch, calendar or none. |
namePattern | string | No | The name of a release made from it. Tokens: {year} {month} {quarter} {week} {version}. |
durationDays | integer | No | Days from the start day to the target day. |
environments | array of string | No | The deployment pipeline, in order. Each environment once. |
checks | array of object | No | The readiness checklist a release made from it starts with. |
notesSections | array of string | No | The headings of the release notes outline. |
Transition releases
Changes dataatlas_releases_transition
Move a release to another status (PLANNED, IN_PROGRESS, READY, RELEASED, ON_HOLD, CANCELLED, ROLLED_BACK). A move the lifecycle does not allow is refused with 409. A move to RELEASED is refused with 409 naming the moratoriums while one that blocks releasing is in force, and no override lifts that. It is also refused with 409, naming the blockers, while scope is empty or open, a required check is unmet, or a sign-off is pending or rejected; a workspace owner or administrator may pass overrideReason to release past those, and the reason is recorded in the release history.
- Scope
releases:write- Calls
- Example prompt
- Mark release 2.4.0 as ready.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
to | "PLANNED" | "IN_PROGRESS" | "READY" | "RELEASED" | "ON_HOLD" | "CANCELLED" | "ROLLED_BACK" | Yes | The status to move the release to. |
overrideReason | string | No | Why a move to RELEASED should go ahead despite its blockers. Only a workspace owner or administrator may use it. Recorded in the release history. |
Update releases
Changes dataatlas_releases_update
Change the details of a release: name, version, type, description, start day, target day, owner or project. Send only the fields to change. The status is changed with atlas_releases_transition.
- Scope
releases:write- Calls
- Example prompt
- Move the target day of release 2.4.0 to 12 November.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The release id. |
name | string | No | A new release name. |
version | string | null | No | A new version, or null to clear it. |
type | "MAJOR" | "MINOR" | "PATCH" | "HOTFIX" | No | A new release type. |
description | string | null | No | A new description, or null to clear it. |
startDate | string | null | No | A new start day. |
targetDate | string | null | No | A new target day. |
ownerId | string | null | No | A new owner, or null for none. |
projectId | string | null | No | A new project, or null to unlink it. |