project_release
Gets or lists a project_release resource.
Overview​
| Name | project_release |
| Type | Resource |
| Id | gitlab.projects.project_release |
Fields​
The following fields are returned by SELECT queries:
- get
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | Global ID of the release. |
name | string | Name of the release. |
tag_name | string | Name of the tag associated with the release. |
author | object | UserCore identity (id, username, name) |
created_at | string | Timestamp of when the release was created. |
description | string | Description (also known as "release notes") of the release. |
historical_release | boolean | Indicates the release is a historical release. |
released_at | string | Timestamp of when the release was released. |
tag_path | string | Relative web path to the tag associated with the release. |
upcoming_release | boolean | Indicates the release is an upcoming release. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | full_path, tag_name, host | A single release of the project. Generated from the GitLab GraphQL schema field Project.release (Release). |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
full_path | string | Full path of the project, for example gitlab-org/gitlab |
host | string | GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST) |
tag_name | string | Name of the tag associated to the release. |
SELECT examples​
- get
A single release of the project. Generated from the GitLab GraphQL schema field Project.release (Release).
SELECT
id,
name,
tag_name,
author,
created_at,
description,
historical_release,
released_at,
tag_path,
upcoming_release
FROM gitlab.projects.project_release
WHERE full_path = '{{ full_path }}' -- required
AND tag_name = '{{ tag_name }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;