git.releases.create

Create a release (and its tag, when new)

POST /git/api/repositories/{repoId}/releasesIAM git:CreateReleaseChanges state

A new tag is created at `target` (default branch when absent) and needs git:PushRepository too. A non-draft release fires `release` with created, published and released (or prereleased); a draft only created. Answers the release and `runIds` of the workflows it started.

Request syntax

POST /git/api/repositories/{repoId}/releases
{
  "tagName": "string",
  "target": "string",
  "name": "string",
  "body": "string",
  "draft": "boolean",
  "prerelease": "boolean"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Request body

  • tagNameRequired

    string

    The tag; created at `target` when it does not exist

    Constraints: 1-255 chars

  • targetOptional

    string

    Branch or commit for a new tag; the default branch when absent

    Constraints: 1-255 chars

  • nameOptional

    string

    Title; the tag name when absent

    Constraints: max 255 chars

  • bodyOptional

    string

    Release notes (Markdown)

    Constraints: max 125000 chars

  • draftOptional

    boolean

    A draft fires only `created`; publish it later

  • prereleaseOptional

    boolean

    Mark it a pre-release (fires `prereleased` instead of `released`); false when absent

Response

201 with the release, as `get` shows it, and `runIds`, the workflow runs it started. 409 when the tag already has a release.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • idAlways

    string

    The release id
  • tagNameAlways

    string

    The tag it publishes, without refs/tags/
  • commitOidAlways

    string

    The commit the tag pointed at when the release was created
  • nameAlways

    string

    The title; the tag name unless one was given
  • bodyAlways

    string

    Release notes (Markdown); empty when none were written
  • draftAlways

    boolean

    A draft is not published yet
  • prereleaseAlways

    boolean

    Marked a pre-release
  • createdAtAlways

    string

    When it was created (ISO 8601)
  • publishedAtAlways

    string, may be null

    When it was published (ISO 8601); null while it is a draft
  • runIdsAlways

    array of string

    Workflow runs the `release` event started; empty when none did

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:CreateRelease on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git releases create repoId --tag-name example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_releases_create.