Releases
Tracks versioned releases in a repository, detailing associated tags, descriptions, and links to attached assets.
View-Specific Information
Select
The add-in uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
- TagName supports the '=,IN' comparison operators.
For example, the following queries are processed server-side:
SELECT * FROM [Releases]
SELECT * FROM [Releases] WHERE [TagName] = 'Val1'
The add-in processes other filters client-side within the add-in.
The add-in uses the GitHub API to process ORDER BY clause conditions that are built with the following columns:
- Name
- CreatedAt
SELECT * FROM [Releases] ORDER BY [Name]
SELECT * FROM [Releases] ORDER BY [CreatedAt]
The add-in uses client-side processing when ordering by any other columns. This impacts performance.
Columns
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | A unique identifier assigned to the release for tracking and reference. | ||
DatabaseId | Int | The primary key value for the release, as stored in the database. | ||
Name | String | The title or name of the release, typically used for display and identification. | ||
Description | String | A detailed explanation of the release, including its purpose and key features. | ||
ShortDescriptionHTML | String | A brief summary of the release, rendered in HTML without links. The output is limited to a set number of characters (default 200). | ||
DescriptionHTML | String | The full description of the release, formatted and rendered in HTML. | ||
IsDraft | Bool | Indicates whether the release is in draft status and not yet published. | ||
IsLatest | Bool | Indicates whether this release is the most recent published version. | ||
IsPrerelease | Bool | Indicates whether this release is a prerelease version, intended for testing before an official launch. | ||
ViewerCanReact | Bool | Indicates whether the current user is allowed to add reactions (such as emoji) to the release. | ||
AuthorId | String | The unique identifier of the user who created the release. | ||
Author | String | The GitHub username of the individual who authored the release. | ||
TagId | String | The unique identifier of the Git tag associated with this release. | ||
TagName | String | The name of the Git tag linked to this release, typically representing a version number. | ||
TagCommitId | String | The commit ID associated with the Git tag for this release. | ||
Url | String | The full HTTP URL to access the release page on GitHub. | ||
ResourcePath | String | The relative HTTP path for accessing the release within the repository. | ||
CreatedAt | Datetime | The date and time when the release was initially created. | ||
PublishedAt | Datetime | The date and time when the release was officially published and made available. | ||
UpdatedAt | Datetime | The date and time when the release was last modified or updated. |