---
title: "Release"
---

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

Path: Pando API

## Fields

- `Release.repo` (string, required)
- `Release.tag` (string, required)
- `Release.sha` (string, required) — Its commit
- `Release.title` (string, required)
- `Release.notes` (string, required) — Markdown
- `Release.draft` (boolean, required)
- `Release.forced` (boolean, required) — Published past red or missing required checks.
- `Release.created_by` (string, required)
- `Release.created_at` (string, required)
  - format `date-time`
- `Release.updated_at` (string, required)
  - format `date-time`
- `Release.published_by` (string | null, required)
- `Release.published_at` (string | null, required)
  - format `date-time`
- `Release.files` (array<object>, required)
  - `Release.files.name` (string, required)
  - `Release.files.size` (integer, required)
  - `Release.files.sha256` (string, required)
  - `Release.files.content_type` (string, required)
  - `Release.files.uploaded_by` (string, required)
  - `Release.files.uploaded_at` (string, required)
    - format `date-time`
- `Release.checks` (object, optional) — Its commit's checks; on getRelease only.
  - `Release.checks.sha` (string | null, required)
  - `Release.checks.state` (string, required) — `success` when the merge gate passes; `missing` when a required context has not reported; `unknown` while the required checks are (an unforced merge is refused).
    - one of `"success"`, `"pending"`, `"failure"`, `"error"`, `"missing"`, `"unknown"`
  - `Release.checks.required` (array | null, required) — Null while unknown.
  - `Release.checks.checks_unknown` (string | null, required) — Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise.
  - `Release.checks.statuses` (array<object>, required) — The latest status per context.
    - `Release.checks.statuses.sha` (string, required)
    - `Release.checks.statuses.context` (string, required)
    - `Release.checks.statuses.state` (string, required)
      - one of `"pending"`, `"success"`, `"failure"`, `"error"`
    - `Release.checks.statuses.created_at` (string, required)
      - format `date-time`
    - `Release.checks.statuses.target_url` (string | null, optional)
    - `Release.checks.statuses.description` (string | null, optional)
    - `Release.checks.statuses.creator` (string, optional) — The member who posted it (a login); `app:<slug>` for a status posted with a status token or by a CI integration; `hook:<hook id>` for a status token from a web hook with no app.
    - `Release.checks.statuses.app` (string | null, optional) — The CI service that reported it (`buildkite`, `github-actions`, ...), stamped by Pando from a status token or a CI integration, never from the body or `target_url`. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows.
  - `Release.checks.missing` (array<string>, optional)


Source: https://docs.gitpando.com/api/schemas/Release/index.md