> ## Documentation Index
> Fetch the complete documentation index at: https://platform.atlan.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> To act on Atlan objects, use the Atlan MCP server at https://api.atlan.com/mcp or the SDK. To install or publish skills from a terminal, use the `brain` CLI; `brain --map json` prints its command map. The `atlanai` CLI is deprecated. Run a read-only identity check before any write.
> The docs MCP server at /mcp searches these docs only. It cannot read or change Atlan objects.
> SDK packages: Python `atlanai` (PyPI) and TypeScript `@atlanai/sdk` (npm). Show Python first, then TypeScript.
> These docs cover Atlan Agent Registry, Atlan's hosted product. The open-source agent registry specification and its CLI (`brain`) are documented, released and maintained in their own repository; /open-source on this site links to it. Answer general specification or `brain` command questions from the project's own docs, and use these docs only for Atlan-specific setup such as the Atlan adapter, sign-in and workspaces.

# Release metrics

> Release a metric revision in Metrics Studio so agents get it, after checking what ships and who it reaches.

<Badge color="orange">Preview</Badge>

Releasing is the step that changes what agents read. A saved revision is private to Studio until you release it, and a released version stays the same when newer revisions are saved. This guide shows you how to release a revision, check what changes and who it reaches before you confirm, and verify the result.

## Before you begin

Before you start, make sure you have:

* **Access**: Access to Metrics Studio and permission to release metrics in the workspace.
* **Saved revision**: The revision you want to ship. See [Write metrics](/studios/metrics/how-tos/write-metrics).
* **Metric app**: An administrator has installed the Metric app in your account.

Releasing distributes a revision. It does not check the SQL or certify the number, so review the definition first.

<Steps>
  <Step title="Open release dialog">
    Open the metric and choose **Release revision N**. Right after you save a change, Studio can open the dialog itself with "Release this revision? Your changes are saved as a new revision. Nothing is released yet."

    The button is unavailable while the release history cannot be loaded ("Release history could not be loaded. Retry before an action that can change distribution.") and while the revision's definition is still loading or failed to load. Choose **Retry** if it failed.
  </Step>

  <Step title="Check what ships and who gets it">
    The dialog tells you, before you confirm:

    * **Which version**: "Revision {n} becomes version {label}." The first release says "It is the first release." A later one says "It replaces {label}, which stays readable by its number."
    * **What ships**: the formula, or a comparison with the live release. The comparison says whether nothing differs, whether only the wording changed ("The calculation is the same, so the numbers do not change. Only the wording does, and agents read it."), or whether "The calculation changes, so the numbers can change."
    * **Who gets it**: "Agents and tools get this revision once it is released.", or for another channel, those that read that channel. It lists what depends on the metric: metrics that use it in their SQL are reached by a change to the calculation, metrics that only list it are not, and a metric built from this one keeps its own copy of the SQL. Choose **Inspect dependencies** to see the links.

    Studio lists only recorded links, so an empty list does not prove nothing uses the metric.
  </Step>

  <Step title="Release revision">
    Optionally open **Add release notes** and write **Release notes (optional)**, up to 4,000 characters. They are saved with the release and shown in **History**.

    To release an earlier revision, or to release on another channel, open **More options: release an earlier revision, or on another channel**. **Version to release** lists the active revisions that have not already shipped on the channel. **Release channel** defaults to `latest`. It is free text, so use a channel your Registry is configured for.

    Choose **Release revision N as {label}**. Studio shows "Released." and a receipt, "Confirmed action receipt", that re-reads the channel, for example "{channel} currently resolves to revision {n}." A release can show as pending: the Registry's checks run first, and agents do not get a pending release yet.

    <Warning>
      A revision cannot be released again on a channel where it already shipped, even after withdrawal. The dialog says "This revision has already been released on this channel. Choose another revision or channel."
    </Warning>
  </Step>

  <Step title="Verify release">
    Choose **View release** in the receipt, or open **History** and choose the version tagged **Live**. Confirm the version label, the channel, and that the formula is the one you meant. Reload the catalog and check that **Release** shows **Live** with your version.
  </Step>

  <Step title="Clear Registry hold (optional)">
    If the catalog shows **Pending review** or **Blocked**, the Registry is holding the newest revision. Open **More actions** and choose **Clear the Registry hold**. It clears the hold on the newest revision so it can be used. It does not check the SQL or certify the number, and it releases nothing, so release the revision afterwards.
  </Step>
</Steps>

If a write is not confirmed ("The server has not confirmed the result. Close this dialog and refresh the item before attempting another write."), the dialog locks to **Close** only. Refresh the metric and read its **History** before you try again. If a dialog says "This item changed after you opened it.", close it, refresh, and review the current version first.

## Next steps

* [Find and read metrics](/studios/metrics/how-tos/find-and-read-metrics): Confirm what agents get after a release.
* [Retire metrics](/studios/metrics/how-tos/retire-metrics): Withdraw a release, name a replacement, or archive a metric.

## See also

* [Metrics Studio](/studios/metrics-studio): How revisions, releases, and withdrawal relate.
* [Write metrics](/studios/metrics/how-tos/write-metrics): Save the next revision.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.