Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gitlab Provider
  3. API Docs
  4. Release
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

gitlab.Release

Explore with Pulumi AI

gitlab logo
GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-gitlab

    The gitlab.Release resource allows to manage the lifecycle of releases in gitlab.

    Upstream API: GitLab REST API docs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

// Create a project
const example = new gitlab.Project("example", {
    name: "example",
    description: "An example project",
});
// Create a release
const exampleRelease = new gitlab.Release("example", {
    project: example.id,
    name: "test-release",
    tagName: "v1.0.0",
    description: "Test release description",
    ref: "main",
});

    import pulumi
import pulumi_gitlab as gitlab

# Create a project
example = gitlab.Project("example",
    name="example",
    description="An example project")
# Create a release
example_release = gitlab.Release("example",
    project=example.id,
    name="test-release",
    tag_name="v1.0.0",
    description="Test release description",
    ref="main")

    package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v8/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a project
		example, err := gitlab.NewProject(ctx, "example", &gitlab.ProjectArgs{
			Name:        pulumi.String("example"),
			Description: pulumi.String("An example project"),
		})
		if err != nil {
			return err
		}
		// Create a release
		_, err = gitlab.NewRelease(ctx, "example", &gitlab.ReleaseArgs{
			Project:     example.ID(),
			Name:        pulumi.String("test-release"),
			TagName:     pulumi.String("v1.0.0"),
			Description: pulumi.String("Test release description"),
			Ref:         pulumi.String("main"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    // Create a project
    var example = new GitLab.Project("example", new()
    {
        Name = "example",
        Description = "An example project",
    });

    // Create a release
    var exampleRelease = new GitLab.Release("example", new()
    {
        Project = example.Id,
        Name = "test-release",
        TagName = "v1.0.0",
        Description = "Test release description",
        Ref = "main",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.Project;
import com.pulumi.gitlab.ProjectArgs;
import com.pulumi.gitlab.Release;
import com.pulumi.gitlab.ReleaseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create a project
        var example = new Project("example", ProjectArgs.builder()
            .name("example")
            .description("An example project")
            .build());

        // Create a release
        var exampleRelease = new Release("exampleRelease", ReleaseArgs.builder()
            .project(example.id())
            .name("test-release")
            .tagName("v1.0.0")
            .description("Test release description")
            .ref("main")
            .build());

    }
}

    resources:
  # Create a project
  example:
    type: gitlab:Project
    properties:
      name: example
      description: An example project
  # Create a release
  exampleRelease:
    type: gitlab:Release
    name: example
    properties:
      project: ${example.id}
      name: test-release
      tagName: v1.0.0
      description: Test release description
      ref: main

    Create Release Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Release(name: string, args: ReleaseArgs, opts?: CustomResourceOptions);
    @overload
def Release(resource_name: str,
            args: ReleaseArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Release(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            project: Optional[str] = None,
            tag_name: Optional[str] = None,
            assets: Optional[ReleaseAssetsArgs] = None,
            description: Optional[str] = None,
            milestones: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            ref: Optional[str] = None,
            released_at: Optional[str] = None,
            tag_message: Optional[str] = None)
    func NewRelease(ctx *Context, name string, args ReleaseArgs, opts ...ResourceOption) (*Release, error)
    public Release(string name, ReleaseArgs args, CustomResourceOptions? opts = null)
    public Release(String name, ReleaseArgs args)
public Release(String name, ReleaseArgs args, CustomResourceOptions options)

    type: gitlab:Release
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ReleaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ReleaseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ReleaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReleaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReleaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var releaseResource = new GitLab.Release("releaseResource", new()
{
    Project = "string",
    TagName = "string",
    Assets = new GitLab.Inputs.ReleaseAssetsArgs
    {
        Count = 0,
    },
    Description = "string",
    Milestones = new[]
    {
        "string",
    },
    Name = "string",
    Ref = "string",
    ReleasedAt = "string",
    TagMessage = "string",
});

    example, err := gitlab.NewRelease(ctx, "releaseResource", &gitlab.ReleaseArgs{
	Project: pulumi.String("string"),
	TagName: pulumi.String("string"),
	Assets: &gitlab.ReleaseAssetsArgs{
		Count: pulumi.Int(0),
	},
	Description: pulumi.String("string"),
	Milestones: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:       pulumi.String("string"),
	Ref:        pulumi.String("string"),
	ReleasedAt: pulumi.String("string"),
	TagMessage: pulumi.String("string"),
})

    var releaseResource = new Release("releaseResource", ReleaseArgs.builder()
    .project("string")
    .tagName("string")
    .assets(ReleaseAssetsArgs.builder()
        .count(0)
        .build())
    .description("string")
    .milestones("string")
    .name("string")
    .ref("string")
    .releasedAt("string")
    .tagMessage("string")
    .build());

    release_resource = gitlab.Release("releaseResource",
    project="string",
    tag_name="string",
    assets={
        "count": 0,
    },
    description="string",
    milestones=["string"],
    name="string",
    ref="string",
    released_at="string",
    tag_message="string")

    const releaseResource = new gitlab.Release("releaseResource", {
    project: "string",
    tagName: "string",
    assets: {
        count: 0,
    },
    description: "string",
    milestones: ["string"],
    name: "string",
    ref: "string",
    releasedAt: "string",
    tagMessage: "string",
});

    type: gitlab:Release
properties:
    assets:
        count: 0
    description: string
    milestones:
        - string
    name: string
    project: string
    ref: string
    releasedAt: string
    tagMessage: string
    tagName: string

    Release Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Release resource accepts the following input properties:

    Project string
    The ID or full path of the project.
    TagName string
    The tag where the release is created from.
    Assets Pulumi.GitLab.Inputs.ReleaseAssets
    The release assets.
    Description string
    The description of the release. You can use Markdown.
    Milestones List<string>
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    Name string
    The name of the release.
    Ref string
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    ReleasedAt string
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    TagMessage string
    Message to use if creating a new annotated tag.
    Project string
    The ID or full path of the project.
    TagName string
    The tag where the release is created from.
    Assets ReleaseAssetsArgs
    The release assets.
    Description string
    The description of the release. You can use Markdown.
    Milestones []string
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    Name string
    The name of the release.
    Ref string
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    ReleasedAt string
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    TagMessage string
    Message to use if creating a new annotated tag.
    project String
    The ID or full path of the project.
    tagName String
    The tag where the release is created from.
    assets ReleaseAssets
    The release assets.
    description String
    The description of the release. You can use Markdown.
    milestones List<String>
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    name String
    The name of the release.
    ref String
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    releasedAt String
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    tagMessage String
    Message to use if creating a new annotated tag.
    project string
    The ID or full path of the project.
    tagName string
    The tag where the release is created from.
    assets ReleaseAssets
    The release assets.
    description string
    The description of the release. You can use Markdown.
    milestones string[]
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    name string
    The name of the release.
    ref string
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    releasedAt string
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    tagMessage string
    Message to use if creating a new annotated tag.
    project str
    The ID or full path of the project.
    tag_name str
    The tag where the release is created from.
    assets ReleaseAssetsArgs
    The release assets.
    description str
    The description of the release. You can use Markdown.
    milestones Sequence[str]
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    name str
    The name of the release.
    ref str
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    released_at str
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    tag_message str
    Message to use if creating a new annotated tag.
    project String
    The ID or full path of the project.
    tagName String
    The tag where the release is created from.
    assets Property Map
    The release assets.
    description String
    The description of the release. You can use Markdown.
    milestones List<String>
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    name String
    The name of the release.
    ref String
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    releasedAt String
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    tagMessage String
    Message to use if creating a new annotated tag.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Release resource produces the following output properties:

    Author Pulumi.GitLab.Outputs.ReleaseAuthor
    The author of the release.
    Commit Pulumi.GitLab.Outputs.ReleaseCommit
    The release commit.
    CommitPath string
    The path to the commit
    CreatedAt string
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    DescriptionHtml string
    HTML rendered Markdown of the release description.
    Id string
    The provider-assigned unique ID for this managed resource.
    Links Pulumi.GitLab.Outputs.ReleaseLinks
    Links of the release
    TagPath string
    The path to the tag.
    UpcomingRelease bool
    Whether the release_at attribute is set to a future date.
    Author ReleaseAuthor
    The author of the release.
    Commit ReleaseCommit
    The release commit.
    CommitPath string
    The path to the commit
    CreatedAt string
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    DescriptionHtml string
    HTML rendered Markdown of the release description.
    Id string
    The provider-assigned unique ID for this managed resource.
    Links ReleaseLinks
    Links of the release
    TagPath string
    The path to the tag.
    UpcomingRelease bool
    Whether the release_at attribute is set to a future date.
    author ReleaseAuthor
    The author of the release.
    commit ReleaseCommit
    The release commit.
    commitPath String
    The path to the commit
    createdAt String
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    descriptionHtml String
    HTML rendered Markdown of the release description.
    id String
    The provider-assigned unique ID for this managed resource.
    links ReleaseLinks
    Links of the release
    tagPath String
    The path to the tag.
    upcomingRelease Boolean
    Whether the release_at attribute is set to a future date.
    author ReleaseAuthor
    The author of the release.
    commit ReleaseCommit
    The release commit.
    commitPath string
    The path to the commit
    createdAt string
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    descriptionHtml string
    HTML rendered Markdown of the release description.
    id string
    The provider-assigned unique ID for this managed resource.
    links ReleaseLinks
    Links of the release
    tagPath string
    The path to the tag.
    upcomingRelease boolean
    Whether the release_at attribute is set to a future date.
    author ReleaseAuthor
    The author of the release.
    commit ReleaseCommit
    The release commit.
    commit_path str
    The path to the commit
    created_at str
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    description_html str
    HTML rendered Markdown of the release description.
    id str
    The provider-assigned unique ID for this managed resource.
    links ReleaseLinks
    Links of the release
    tag_path str
    The path to the tag.
    upcoming_release bool
    Whether the release_at attribute is set to a future date.
    author Property Map
    The author of the release.
    commit Property Map
    The release commit.
    commitPath String
    The path to the commit
    createdAt String
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    descriptionHtml String
    HTML rendered Markdown of the release description.
    id String
    The provider-assigned unique ID for this managed resource.
    links Property Map
    Links of the release
    tagPath String
    The path to the tag.
    upcomingRelease Boolean
    Whether the release_at attribute is set to a future date.

    Look up Existing Release Resource

    Get an existing Release resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ReleaseState, opts?: CustomResourceOptions): Release
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assets: Optional[ReleaseAssetsArgs] = None,
        author: Optional[ReleaseAuthorArgs] = None,
        commit: Optional[ReleaseCommitArgs] = None,
        commit_path: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        description_html: Optional[str] = None,
        links: Optional[ReleaseLinksArgs] = None,
        milestones: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        ref: Optional[str] = None,
        released_at: Optional[str] = None,
        tag_message: Optional[str] = None,
        tag_name: Optional[str] = None,
        tag_path: Optional[str] = None,
        upcoming_release: Optional[bool] = None) -> Release
    func GetRelease(ctx *Context, name string, id IDInput, state *ReleaseState, opts ...ResourceOption) (*Release, error)
    public static Release Get(string name, Input<string> id, ReleaseState? state, CustomResourceOptions? opts = null)
    public static Release get(String name, Output<String> id, ReleaseState state, CustomResourceOptions options)
    resources:  _:    type: gitlab:Release    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Assets Pulumi.GitLab.Inputs.ReleaseAssets
    The release assets.
    Author Pulumi.GitLab.Inputs.ReleaseAuthor
    The author of the release.
    Commit Pulumi.GitLab.Inputs.ReleaseCommit
    The release commit.
    CommitPath string
    The path to the commit
    CreatedAt string
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    Description string
    The description of the release. You can use Markdown.
    DescriptionHtml string
    HTML rendered Markdown of the release description.
    Links Pulumi.GitLab.Inputs.ReleaseLinks
    Links of the release
    Milestones List<string>
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    Name string
    The name of the release.
    Project string
    The ID or full path of the project.
    Ref string
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    ReleasedAt string
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    TagMessage string
    Message to use if creating a new annotated tag.
    TagName string
    The tag where the release is created from.
    TagPath string
    The path to the tag.
    UpcomingRelease bool
    Whether the release_at attribute is set to a future date.
    Assets ReleaseAssetsArgs
    The release assets.
    Author ReleaseAuthorArgs
    The author of the release.
    Commit ReleaseCommitArgs
    The release commit.
    CommitPath string
    The path to the commit
    CreatedAt string
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    Description string
    The description of the release. You can use Markdown.
    DescriptionHtml string
    HTML rendered Markdown of the release description.
    Links ReleaseLinksArgs
    Links of the release
    Milestones []string
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    Name string
    The name of the release.
    Project string
    The ID or full path of the project.
    Ref string
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    ReleasedAt string
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    TagMessage string
    Message to use if creating a new annotated tag.
    TagName string
    The tag where the release is created from.
    TagPath string
    The path to the tag.
    UpcomingRelease bool
    Whether the release_at attribute is set to a future date.
    assets ReleaseAssets
    The release assets.
    author ReleaseAuthor
    The author of the release.
    commit ReleaseCommit
    The release commit.
    commitPath String
    The path to the commit
    createdAt String
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    description String
    The description of the release. You can use Markdown.
    descriptionHtml String
    HTML rendered Markdown of the release description.
    links ReleaseLinks
    Links of the release
    milestones List<String>
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    name String
    The name of the release.
    project String
    The ID or full path of the project.
    ref String
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    releasedAt String
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    tagMessage String
    Message to use if creating a new annotated tag.
    tagName String
    The tag where the release is created from.
    tagPath String
    The path to the tag.
    upcomingRelease Boolean
    Whether the release_at attribute is set to a future date.
    assets ReleaseAssets
    The release assets.
    author ReleaseAuthor
    The author of the release.
    commit ReleaseCommit
    The release commit.
    commitPath string
    The path to the commit
    createdAt string
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    description string
    The description of the release. You can use Markdown.
    descriptionHtml string
    HTML rendered Markdown of the release description.
    links ReleaseLinks
    Links of the release
    milestones string[]
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    name string
    The name of the release.
    project string
    The ID or full path of the project.
    ref string
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    releasedAt string
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    tagMessage string
    Message to use if creating a new annotated tag.
    tagName string
    The tag where the release is created from.
    tagPath string
    The path to the tag.
    upcomingRelease boolean
    Whether the release_at attribute is set to a future date.
    assets ReleaseAssetsArgs
    The release assets.
    author ReleaseAuthorArgs
    The author of the release.
    commit ReleaseCommitArgs
    The release commit.
    commit_path str
    The path to the commit
    created_at str
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    description str
    The description of the release. You can use Markdown.
    description_html str
    HTML rendered Markdown of the release description.
    links ReleaseLinksArgs
    Links of the release
    milestones Sequence[str]
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    name str
    The name of the release.
    project str
    The ID or full path of the project.
    ref str
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    released_at str
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    tag_message str
    Message to use if creating a new annotated tag.
    tag_name str
    The tag where the release is created from.
    tag_path str
    The path to the tag.
    upcoming_release bool
    Whether the release_at attribute is set to a future date.
    assets Property Map
    The release assets.
    author Property Map
    The author of the release.
    commit Property Map
    The release commit.
    commitPath String
    The path to the commit
    createdAt String
    Date and time the release was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    description String
    The description of the release. You can use Markdown.
    descriptionHtml String
    HTML rendered Markdown of the release description.
    links Property Map
    Links of the release
    milestones List<String>
    The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
    name String
    The name of the release.
    project String
    The ID or full path of the project.
    ref String
    If a tag specified in tagname doesn't exist, the release is created from ref and tagged with tagname. It can be a commit SHA, another tag name, or a branch name.
    releasedAt String
    Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.
    tagMessage String
    Message to use if creating a new annotated tag.
    tagName String
    The tag where the release is created from.
    tagPath String
    The path to the tag.
    upcomingRelease Boolean
    Whether the release_at attribute is set to a future date.

    Supporting Types

    ReleaseAssets, ReleaseAssetsArgs

    Count int
    The total count of assets in this release.
    Count int
    The total count of assets in this release.
    count Integer
    The total count of assets in this release.
    count number
    The total count of assets in this release.
    count int
    The total count of assets in this release.
    count Number
    The total count of assets in this release.

    ReleaseAuthor, ReleaseAuthorArgs

    AvatarUrl string
    The url of the author's' user avatar.
    Id int
    The ID of the author's user.
    Name string
    The name of the author.
    State string
    The state of the author's user.
    Username string
    The username of the author.
    WebUrl string
    The url to the author's user profile.
    AvatarUrl string
    The url of the author's' user avatar.
    Id int
    The ID of the author's user.
    Name string
    The name of the author.
    State string
    The state of the author's user.
    Username string
    The username of the author.
    WebUrl string
    The url to the author's user profile.
    avatarUrl String
    The url of the author's' user avatar.
    id Integer
    The ID of the author's user.
    name String
    The name of the author.
    state String
    The state of the author's user.
    username String
    The username of the author.
    webUrl String
    The url to the author's user profile.
    avatarUrl string
    The url of the author's' user avatar.
    id number
    The ID of the author's user.
    name string
    The name of the author.
    state string
    The state of the author's user.
    username string
    The username of the author.
    webUrl string
    The url to the author's user profile.
    avatar_url str
    The url of the author's' user avatar.
    id int
    The ID of the author's user.
    name str
    The name of the author.
    state str
    The state of the author's user.
    username str
    The username of the author.
    web_url str
    The url to the author's user profile.
    avatarUrl String
    The url of the author's' user avatar.
    id Number
    The ID of the author's user.
    name String
    The name of the author.
    state String
    The state of the author's user.
    username String
    The username of the author.
    webUrl String
    The url to the author's user profile.

    ReleaseCommit, ReleaseCommitArgs

    AuthorEmail string
    The email address of the commit author.
    AuthorName string
    The name of the commit author.
    AuthoredDate string
    The date and time the commit was authored. In ISO 8601 format (2019-03-15T08:00:00Z).
    CommittedDate string
    The date and time the commit was made. In ISO 8601 format (2019-03-15T08:00:00Z).
    CommitterEmail string
    The email address of the committer.
    CommitterName string
    The name of the committer.
    CreatedAt string
    The date and time the commit was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    Id string
    The git commit full SHA
    Message string
    The commit message.
    ParentIds List<string>
    The full SHA of any parent commits.
    ShortId string
    The git commit short SHA.
    Title string
    The title of the commit.
    AuthorEmail string
    The email address of the commit author.
    AuthorName string
    The name of the commit author.
    AuthoredDate string
    The date and time the commit was authored. In ISO 8601 format (2019-03-15T08:00:00Z).
    CommittedDate string
    The date and time the commit was made. In ISO 8601 format (2019-03-15T08:00:00Z).
    CommitterEmail string
    The email address of the committer.
    CommitterName string
    The name of the committer.
    CreatedAt string
    The date and time the commit was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    Id string
    The git commit full SHA
    Message string
    The commit message.
    ParentIds []string
    The full SHA of any parent commits.
    ShortId string
    The git commit short SHA.
    Title string
    The title of the commit.
    authorEmail String
    The email address of the commit author.
    authorName String
    The name of the commit author.
    authoredDate String
    The date and time the commit was authored. In ISO 8601 format (2019-03-15T08:00:00Z).
    committedDate String
    The date and time the commit was made. In ISO 8601 format (2019-03-15T08:00:00Z).
    committerEmail String
    The email address of the committer.
    committerName String
    The name of the committer.
    createdAt String
    The date and time the commit was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    id String
    The git commit full SHA
    message String
    The commit message.
    parentIds List<String>
    The full SHA of any parent commits.
    shortId String
    The git commit short SHA.
    title String
    The title of the commit.
    authorEmail string
    The email address of the commit author.
    authorName string
    The name of the commit author.
    authoredDate string
    The date and time the commit was authored. In ISO 8601 format (2019-03-15T08:00:00Z).
    committedDate string
    The date and time the commit was made. In ISO 8601 format (2019-03-15T08:00:00Z).
    committerEmail string
    The email address of the committer.
    committerName string
    The name of the committer.
    createdAt string
    The date and time the commit was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    id string
    The git commit full SHA
    message string
    The commit message.
    parentIds string[]
    The full SHA of any parent commits.
    shortId string
    The git commit short SHA.
    title string
    The title of the commit.
    author_email str
    The email address of the commit author.
    author_name str
    The name of the commit author.
    authored_date str
    The date and time the commit was authored. In ISO 8601 format (2019-03-15T08:00:00Z).
    committed_date str
    The date and time the commit was made. In ISO 8601 format (2019-03-15T08:00:00Z).
    committer_email str
    The email address of the committer.
    committer_name str
    The name of the committer.
    created_at str
    The date and time the commit was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    id str
    The git commit full SHA
    message str
    The commit message.
    parent_ids Sequence[str]
    The full SHA of any parent commits.
    short_id str
    The git commit short SHA.
    title str
    The title of the commit.
    authorEmail String
    The email address of the commit author.
    authorName String
    The name of the commit author.
    authoredDate String
    The date and time the commit was authored. In ISO 8601 format (2019-03-15T08:00:00Z).
    committedDate String
    The date and time the commit was made. In ISO 8601 format (2019-03-15T08:00:00Z).
    committerEmail String
    The email address of the committer.
    committerName String
    The name of the committer.
    createdAt String
    The date and time the commit was created. In ISO 8601 format (2019-03-15T08:00:00Z).
    id String
    The git commit full SHA
    message String
    The commit message.
    parentIds List<String>
    The full SHA of any parent commits.
    shortId String
    The git commit short SHA.
    title String
    The title of the commit.
    ClosedIssuesUrl string
    URL of the release's closed issues.
    ClosedMergeRequestsUrl string
    URL of the release's closed merge requests.
    EditUrl string
    URL of the release's edit page.
    MergedMergeRequestsUrl string
    URL of the release's merged merge requests.
    OpenedIssuesUrl string
    URL of the release's open issues.
    OpenedMergeRequestsUrl string
    URL of the release's open merge requests.
    Self string
    URL of the release.
    ClosedIssuesUrl string
    URL of the release's closed issues.
    ClosedMergeRequestsUrl string
    URL of the release's closed merge requests.
    EditUrl string
    URL of the release's edit page.
    MergedMergeRequestsUrl string
    URL of the release's merged merge requests.
    OpenedIssuesUrl string
    URL of the release's open issues.
    OpenedMergeRequestsUrl string
    URL of the release's open merge requests.
    Self string
    URL of the release.
    closedIssuesUrl String
    URL of the release's closed issues.
    closedMergeRequestsUrl String
    URL of the release's closed merge requests.
    editUrl String
    URL of the release's edit page.
    mergedMergeRequestsUrl String
    URL of the release's merged merge requests.
    openedIssuesUrl String
    URL of the release's open issues.
    openedMergeRequestsUrl String
    URL of the release's open merge requests.
    self String
    URL of the release.
    closedIssuesUrl string
    URL of the release's closed issues.
    closedMergeRequestsUrl string
    URL of the release's closed merge requests.
    editUrl string
    URL of the release's edit page.
    mergedMergeRequestsUrl string
    URL of the release's merged merge requests.
    openedIssuesUrl string
    URL of the release's open issues.
    openedMergeRequestsUrl string
    URL of the release's open merge requests.
    self string
    URL of the release.
    closed_issues_url str
    URL of the release's closed issues.
    closed_merge_requests_url str
    URL of the release's closed merge requests.
    edit_url str
    URL of the release's edit page.
    merged_merge_requests_url str
    URL of the release's merged merge requests.
    opened_issues_url str
    URL of the release's open issues.
    opened_merge_requests_url str
    URL of the release's open merge requests.
    self str
    URL of the release.
    closedIssuesUrl String
    URL of the release's closed issues.
    closedMergeRequestsUrl String
    URL of the release's closed merge requests.
    editUrl String
    URL of the release's edit page.
    mergedMergeRequestsUrl String
    URL of the release's merged merge requests.
    openedIssuesUrl String
    URL of the release's open issues.
    openedMergeRequestsUrl String
    URL of the release's open merge requests.
    self String
    URL of the release.

    Import

    Starting in Terraform v1.5.0 you can use an import block to import gitlab_release. For example:

    terraform

    import {

    to = gitlab_release.example

    id = “see CLI command below for ID”

    }

    Import using the CLI is supported using the following syntax:

    Gitlab release link can be imported with a key composed of <project>:<tag_name>, e.g.

    $ pulumi import gitlab:index/release:Release example "12345:test"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
    pulumi/pulumi-gitlab