Update Release
github.update_release
ActionBusiness appsconnection required
Calls the GitHub API PATCH /repos/{owner}/{repo}/releases/{release_id}.
Change a release's tag, title, notes or draft state.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- GitHub
- Secret shape
- the GitHub personal access token
- Resolved by
- config.connection_id, else node.connection_id, else the tenant's sole GitHub connection
Configuration
9 fields, 3 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
owner Repository owner — the user or organisation login. Supports {{ }}. | string | Yes | — | — | octocat |
repo Repository name, without the owner prefix. Supports {{ }}. | string | Yes | — | — | hello-world |
release_id Numeric release id to update. | string | Yes | — | — | 1 |
tag_name New tag name. | string | No | — | — | — |
target_commitish New target branch or commit. | string | No | — | — | — |
name New release title. | string | No | — | — | — |
body New release notes (Markdown). | string | No | — | — | — |
draft Set false to publish a draft release. | boolean | No | — | — | — |
prerelease Mark or unmark it as a pre-release. | boolean | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"owner": "octocat",
"release_id": "1",
"repo": "hello-world"
}Output
One shape.
result
The declared fields, plus the rest of the resource as GitHub returned it.
Extra keys beyond the ones listed can appear.
| Field | Type | Example |
|---|---|---|
ok True when GitHub accepted the call. | boolean | true |
id Release id, used by the asset endpoints. | number | — |
tag_name Tag the release points at. | string | — |
name Release title. | string | — |
draft True while the release is unpublished. | boolean | — |
prerelease True for a pre-release. | boolean | — |
html_url Link to the release page. | string | — |
{
"draft": false,
"html_url": "",
"id": 0,
"name": "",
"ok": true,
"prerelease": false,
"tag_name": ""
}Notes
- At least one changeable field must be set, or the step fails before it calls.
Solutions with GitHub
See Update Release run in a workflow.
In a technical demo we add the GitHub connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.