Releases
Tracks versioned releases in a repository, detailing associated tags, descriptions, and links to attached assets.
Table-Specific Information
Select
The component 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 component processes other filters client-side within the component.
The component 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 component processes ordering by other columns client-side within the component.
Insert
You can use the following columns to create (insert) a new record:
- Name
- Description
- IsDraft
- IsPrerelease
- TagName
- TagCommitOid
You can use the following pseudo-columns to create a new record:
- MakeLatest
- DiscussionCategoryName
- GenerateReleaseNotes
INSERT INTO [Releases] ([Name], [Description], [IsDraft], [IsPrerelease], [TagName], [TagCommitOid], [MakeLatest], [GenerateReleaseNotes], [DiscussionCategoryName]) VALUES ('TestRelease', 'Test release description.', false, false, 'v3.6', '0cd56625bdf83fbe33c19dcf82a17c4e40b7efa2', 'legacy', true, 'Ideas');
Update
You can use the following columns to update a record:
- Name
- Description
- IsDraft
- IsPrerelease
- TagName
- TagCommitOid
You can use the following pseudo-columns to update a record:
- MakeLatest
- DiscussionCategoryName
UPDATE [Releases] SET [TagName] = 'v3.0', [TagCommitOid] = '3a733d86cd951b902a1ed397457321da5d8157ac', [Name] = 'ChangedName', [Description] = 'Changed text.', [IsDraft] = true, [IsPrerelease] = true, [MakeLatest] = 'false', [DiscussionCategoryName] = 'Polls' WHERE [DatabaseId] = '257443258'
Delete
You can specify the following column to delete a record: DatabaseId
DELETE FROM [Releases] WHERE [DatabaseId] = '257443258'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A unique identifier assigned to the release for tracking and reference. | |
| DatabaseId | Int | True |
The primary key value for the release, as stored in the database. | |
| Name | String | False |
The title or name of the release, typically used for display and identification. | |
| Description | String | False |
A detailed explanation of the release, including its purpose and key features. | |
| ShortDescriptionHTML | String | True |
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 | True |
The full description of the release, formatted and rendered in HTML. | |
| IsDraft | Bool | False |
Indicates whether the release is in draft status and not yet published. | |
| IsLatest | Bool | True |
Indicates whether this release is the most recent published version. | |
| IsPrerelease | Bool | False |
Indicates whether this release is a prerelease version, intended for testing before an official launch. | |
| ViewerCanReact | Bool | True |
Indicates whether the current user is allowed to add reactions (such as emoji) to the release. | |
| AuthorId | String | True |
The unique identifier of the user who created the release. | |
| Author | String | True |
The GitHub username of the individual who authored the release. | |
| TagId | String | True |
The unique identifier of the Git tag associated with this release. | |
| TagName | String | False |
The name of the Git tag linked to this release, typically representing a version number. | |
| TagCommitId | String | True |
The commit ID associated with the Git tag for this release. | |
| TagCommitOid | String | False |
The commit SHA associated with the Git tag for this release. | |
| Url | String | True |
The full HTTP URL to access the release page on GitHub. | |
| ResourcePath | String | True |
The relative HTTP path for accessing the release within the repository. | |
| CreatedAt | Datetime | True |
The date and time when the release was initially created. | |
| PublishedAt | Datetime | True |
The date and time when the release was officially published and made available. | |
| UpdatedAt | Datetime | True |
The date and time when the release was last modified or updated. |
Pseudo-Columns
Pseudo-columns are fields that can be used in WHERE clauses to filter data, but do not contain data themselves.
| Name | Type | Description |
| MakeLatest | String |
Specifies whether this release should be set as the latest release. Defaults to true for newly published releases. Legacy specifies that the latest release should be determined based on the release creation date and higher semantic version. |
| DiscussionCategoryName | String |
If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. |
| GenerateReleaseNotes | Bool |
Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes. |