Release

Release is the GitHub component that manages a repository’s published versions, which GitHub calls releases: each one has a tag (for example v1.2.0), a name and a description of what is new. With it you can publish a new release, look up one release or the full list, change its name or description, and delete it.

It is useful when publishing a release is part of a wider process, for example when an agent writes the release notes or when you want to tell your customers about every new version.

When to use it

An agent writes release notes from the closed tasks and you want to publish them in GitHub.
You want to email your customers what is new every time a release is published.
You want to keep the release history of your products in a spreadsheet.
You need to fix the description of a release that is already published.

Configuration

You need a GitHub API credential with a GitHub Personal Access Token that has access to the repository. See Credentials.

Field	What it does
Credential (required)	The GitHub API credential used to access your account.
Repository Input Type	How you specify the repository. `Select` picks it from a list; `Manual` lets you type it. Default: `Select`.
Repository (required)	With `Select`. The repository to work with. The list loads when you choose the credential and shows up to 100 repositories from your account; if yours is not there, use `Manual`.
Repository ID (required)	With `Manual`. The repository in the format `owner/repository`, for example `my-company/app`. It also accepts the repository’s GitHub link.
Operation (required)	What the component does. See Operations. Default: `Create Release`.
Release Tag (required)	The release’s tag, for example `v1.2.0`. Used in every operation except `List All`.
Release Name (required)	Only in `Create Release` and `Update Release`. The release’s name. In `Update Release`, leaving it empty keeps the current one.
Release Description (required)	Only in `Create Release` and `Update Release`. The release’s description or notes. In `Update Release`, leaving it empty keeps the current one.

Operations

Operation	What it does
`Get Release`	Returns the details of the release with that tag.
`Create Release`	Publishes a new release with the tag, name and description you set.
`Update Release`	Changes the name or description of an existing release. You must fill in at least one of them.
`Delete Release`	Deletes the release with that tag.
`List All`	Returns the repository’s list of releases.

Advanced options

Field	What it does
Limit	Only in `List All`. The maximum number of releases to return, up to 1000. Default: 100.

Output

The Data output depends on the operation:

Get Release and List All: the tag, name, description, link, creation and publication dates, and whether it is a draft or a pre-release. With List All you get one item per release.
Create Release and Update Release: a confirmation with the release’s tag and link.
Delete Release: a confirmation with the deleted tag.

You can connect the result to an email or messaging component to announce the release, or to an agent so it can write a summary. The component can also be connected to an Agent as a tool. See Tool Mode.

Example

A product team wants to publish every release with notes written by an agent.

An agent writes the release notes from the list of finished tasks.
Add Release with the Create Release operation and pick the application’s repository.
In Release Tag write v2.4.0 and in Release Name Version 2.4.
Connect the agent’s answer to Release Description.
Connect the Data output to an email for the sales team with the release link.

Good practices

Always use the same tag format, for example v followed by the version number: the other operations find the release by that exact tag.
Check the tag before using Delete Release. Deleting a release cannot be undone from NappAI.

Repository: lists the repositories in your account.
Issue: manage a repository’s issues.
Review: work with pull requests and their reviews.
File: read and write files in a repository.