Skip to main content

project_release

Gets or lists a project_release resource.

Overview​

Nameproject_release
TypeResource
Idgitlab.projects.project_release

Fields​

The following fields are returned by SELECT queries:

GraphQL response envelope

NameDatatypeDescription
idstringGlobal ID of the release.
namestringName of the release.
tag_namestringName of the tag associated with the release.
authorobjectUserCore identity (id, username, name)
created_atstringTimestamp of when the release was created.
descriptionstringDescription (also known as "release notes") of the release.
historical_releasebooleanIndicates the release is a historical release.
released_atstringTimestamp of when the release was released.
tag_pathstringRelative web path to the tag associated with the release.
upcoming_releasebooleanIndicates the release is an upcoming release.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectfull_path, tag_name, hostA 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.

NameDatatypeDescription
full_pathstringFull path of the project, for example gitlab-org/gitlab
hoststringGitLab 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_namestringName of the tag associated to the release.

SELECT examples​

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)
;