Appearance
github.releases.create_release ​
Create a GitHub release and its tag through an installed GitHub App connection.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Organization UUID |
actor | string | No | — | Actor initiating the workflow |
workflow_run_id | string | No | — | Parent workflow run id |
dry_run | boolean | No | — | Validate and plan without mutating GitHub |
github_connection_uuid | uuid | No | — | Deprecated/ignored — the GitHub App installation is resolved by repository owner. |
repository | string | Yes | — | Repository owner/name |
tag_name | string | Yes | — | Release tag, e.g. v1.2.3 |
target_commitish | string | No | — | Branch or SHA the tag is created from (defaults to the repo default branch) |
name | string | No | — | Release title (defaults to tag) |
body | string | No | — | Release notes body |
draft | boolean | No | — | Create as a draft release |
prerelease | boolean | No | — | Mark as a prerelease |
make_latest | string | No | — | Whether this is the latest release: true, false, or legacy |
generate_release_notes | boolean | No | — | Let GitHub auto-generate notes (merged into body) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | planned, created, already_exists, or failed |
repository | string | No | — | — |
tag_name | string | No | — | — |
github_release_ref | integer | No | — | — |
html_url | string | No | — | — |
upload_url | string | No | — | — |
draft | boolean | No | — | — |
prerelease | boolean | No | — | — |
applied | boolean | No | — | — |
dry_run | boolean | No | — | — |
warnings | list | No | — | — |
failure_reason | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.releases.create_release",
"initial_data": {
"organization_uuid": "value",
"repository": "value",
"tag_name": "value"
}
}