pulumi-gitlab-kotlin/com.pulumi.gitlab.kotlin/GroupBadgeArgs

GroupBadgeArgs

data class GroupBadgeArgs(val group: Output<String>? = null, val imageUrl: Output<String>? = null, val linkUrl: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<GroupBadgeArgs>

The gitlab.GroupBadge resource allows to manage the lifecycle of group badges. Upstream API: GitLab REST API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const foo = new gitlab.Group("foo", {name: "foo-group"});
const example = new gitlab.GroupBadge("example", {
    group: foo.id,
    linkUrl: "https://example.com/badge-123",
    imageUrl: "https://example.com/badge-123.svg",
});
// Pipeline status badges with placeholders will be enabled for each project
const gitlabPipeline = new gitlab.GroupBadge("gitlab_pipeline", {
    group: foo.id,
    linkUrl: "https://gitlab.example.com/%{project_path}/-/pipelines?ref=%{default_branch}",
    imageUrl: "https://gitlab.example.com/%{project_path}/badges/%{default_branch}/pipeline.svg",
});
// Test coverage report badges with placeholders will be enabled for each project
const gitlabCoverage = new gitlab.GroupBadge("gitlab_coverage", {
    group: foo.id,
    linkUrl: "https://gitlab.example.com/%{project_path}/-/jobs",
    imageUrl: "https://gitlab.example.com/%{project_path}/badges/%{default_branch}/coverage.svg",
});
// Latest release badges with placeholders will be enabled for each project
const gitlabRelease = new gitlab.GroupBadge("gitlab_release", {
    group: foo.id,
    linkUrl: "https://gitlab.example.com/%{project_path}/-/releases",
    imageUrl: "https://gitlab.example.com/%{project_path}/-/badges/release.svg",
});
Content copied to clipboard
import pulumi
import pulumi_gitlab as gitlab
foo = gitlab.Group("foo", name="foo-group")
example = gitlab.GroupBadge("example",
    group=foo.id,
    link_url="https://example.com/badge-123",
    image_url="https://example.com/badge-123.svg")
# Pipeline status badges with placeholders will be enabled for each project
gitlab_pipeline = gitlab.GroupBadge("gitlab_pipeline",
    group=foo.id,
    link_url="https://gitlab.example.com/%{project_path}/-/pipelines?ref=%{default_branch}",
    image_url="https://gitlab.example.com/%{project_path}/badges/%{default_branch}/pipeline.svg")
# Test coverage report badges with placeholders will be enabled for each project
gitlab_coverage = gitlab.GroupBadge("gitlab_coverage",
    group=foo.id,
    link_url="https://gitlab.example.com/%{project_path}/-/jobs",
    image_url="https://gitlab.example.com/%{project_path}/badges/%{default_branch}/coverage.svg")
# Latest release badges with placeholders will be enabled for each project
gitlab_release = gitlab.GroupBadge("gitlab_release",
    group=foo.id,
    link_url="https://gitlab.example.com/%{project_path}/-/releases",
    image_url="https://gitlab.example.com/%{project_path}/-/badges/release.svg")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
    var foo = new GitLab.Group("foo", new()
    {
        Name = "foo-group",
    });
    var example = new GitLab.GroupBadge("example", new()
    {
        Group = foo.Id,
        LinkUrl = "https://example.com/badge-123",
        ImageUrl = "https://example.com/badge-123.svg",
    });
    // Pipeline status badges with placeholders will be enabled for each project
    var gitlabPipeline = new GitLab.GroupBadge("gitlab_pipeline", new()
    {
        Group = foo.Id,
        LinkUrl = "https://gitlab.example.com/%{project_path}/-/pipelines?ref=%{default_branch}",
        ImageUrl = "https://gitlab.example.com/%{project_path}/badges/%{default_branch}/pipeline.svg",
    });
    // Test coverage report badges with placeholders will be enabled for each project
    var gitlabCoverage = new GitLab.GroupBadge("gitlab_coverage", new()
    {
        Group = foo.Id,
        LinkUrl = "https://gitlab.example.com/%{project_path}/-/jobs",
        ImageUrl = "https://gitlab.example.com/%{project_path}/badges/%{default_branch}/coverage.svg",
    });
    // Latest release badges with placeholders will be enabled for each project
    var gitlabRelease = new GitLab.GroupBadge("gitlab_release", new()
    {
        Group = foo.Id,
        LinkUrl = "https://gitlab.example.com/%{project_path}/-/releases",
        ImageUrl = "https://gitlab.example.com/%{project_path}/-/badges/release.svg",
    });
});
Content copied to clipboard
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 {
		foo, err := gitlab.NewGroup(ctx, "foo", &gitlab.GroupArgs{
			Name: pulumi.String("foo-group"),
		})
		if err != nil {
			return err
		}
		_, err = gitlab.NewGroupBadge(ctx, "example", &gitlab.GroupBadgeArgs{
			Group:    foo.ID(),
			LinkUrl:  pulumi.String("https://example.com/badge-123"),
			ImageUrl: pulumi.String("https://example.com/badge-123.svg"),
		})
		if err != nil {
			return err
		}
		// Pipeline status badges with placeholders will be enabled for each project
		_, err = gitlab.NewGroupBadge(ctx, "gitlab_pipeline", &gitlab.GroupBadgeArgs{
			Group:    foo.ID(),
			LinkUrl:  pulumi.String("https://gitlab.example.com/%{project_path}/-/pipelines?ref=%{default_branch}"),
			ImageUrl: pulumi.String("https://gitlab.example.com/%{project_path}/badges/%{default_branch}/pipeline.svg"),
		})
		if err != nil {
			return err
		}
		// Test coverage report badges with placeholders will be enabled for each project
		_, err = gitlab.NewGroupBadge(ctx, "gitlab_coverage", &gitlab.GroupBadgeArgs{
			Group:    foo.ID(),
			LinkUrl:  pulumi.String("https://gitlab.example.com/%{project_path}/-/jobs"),
			ImageUrl: pulumi.String("https://gitlab.example.com/%{project_path}/badges/%{default_branch}/coverage.svg"),
		})
		if err != nil {
			return err
		}
		// Latest release badges with placeholders will be enabled for each project
		_, err = gitlab.NewGroupBadge(ctx, "gitlab_release", &gitlab.GroupBadgeArgs{
			Group:    foo.ID(),
			LinkUrl:  pulumi.String("https://gitlab.example.com/%{project_path}/-/releases"),
			ImageUrl: pulumi.String("https://gitlab.example.com/%{project_path}/-/badges/release.svg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.Group;
import com.pulumi.gitlab.GroupArgs;
import com.pulumi.gitlab.GroupBadge;
import com.pulumi.gitlab.GroupBadgeArgs;
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) {
        var foo = new Group("foo", GroupArgs.builder()
            .name("foo-group")
            .build());
        var example = new GroupBadge("example", GroupBadgeArgs.builder()
            .group(foo.id())
            .linkUrl("https://example.com/badge-123")
            .imageUrl("https://example.com/badge-123.svg")
            .build());
        // Pipeline status badges with placeholders will be enabled for each project
        var gitlabPipeline = new GroupBadge("gitlabPipeline", GroupBadgeArgs.builder()
            .group(foo.id())
            .linkUrl("https://gitlab.example.com/%{project_path}/-/pipelines?ref=%{default_branch}")
            .imageUrl("https://gitlab.example.com/%{project_path}/badges/%{default_branch}/pipeline.svg")
            .build());
        // Test coverage report badges with placeholders will be enabled for each project
        var gitlabCoverage = new GroupBadge("gitlabCoverage", GroupBadgeArgs.builder()
            .group(foo.id())
            .linkUrl("https://gitlab.example.com/%{project_path}/-/jobs")
            .imageUrl("https://gitlab.example.com/%{project_path}/badges/%{default_branch}/coverage.svg")
            .build());
        // Latest release badges with placeholders will be enabled for each project
        var gitlabRelease = new GroupBadge("gitlabRelease", GroupBadgeArgs.builder()
            .group(foo.id())
            .linkUrl("https://gitlab.example.com/%{project_path}/-/releases")
            .imageUrl("https://gitlab.example.com/%{project_path}/-/badges/release.svg")
            .build());
    }
}
Content copied to clipboard
resources:
  foo:
    type: gitlab:Group
    properties:
      name: foo-group
  example:
    type: gitlab:GroupBadge
    properties:
      group: ${foo.id}
      linkUrl: https://example.com/badge-123
      imageUrl: https://example.com/badge-123.svg
  # Pipeline status badges with placeholders will be enabled for each project
  gitlabPipeline:
    type: gitlab:GroupBadge
    name: gitlab_pipeline
    properties:
      group: ${foo.id}
      linkUrl: https://gitlab.example.com/%{project_path}/-/pipelines?ref=%{default_branch}
      imageUrl: https://gitlab.example.com/%{project_path}/badges/%{default_branch}/pipeline.svg
  # Test coverage report badges with placeholders will be enabled for each project
  gitlabCoverage:
    type: gitlab:GroupBadge
    name: gitlab_coverage
    properties:
      group: ${foo.id}
      linkUrl: https://gitlab.example.com/%{project_path}/-/jobs
      imageUrl: https://gitlab.example.com/%{project_path}/badges/%{default_branch}/coverage.svg
  # Latest release badges with placeholders will be enabled for each project
  gitlabRelease:
    type: gitlab:GroupBadge
    name: gitlab_release
    properties:
      group: ${foo.id}
      linkUrl: https://gitlab.example.com/%{project_path}/-/releases
      imageUrl: https://gitlab.example.com/%{project_path}/-/badges/release.svg
Content copied to clipboard

Import

Starting in Terraform v1.5.0 you can use an import block to import gitlab_group_badge. For example: terraform import { to = gitlab_group_badge.example id = "see CLI command below for ID" } Import using the CLI is supported using the following syntax: GitLab group badges can be imported using an id made up of {group_id}:{badge_id}, e.g.

$ pulumi import gitlab:index/groupBadge:GroupBadge foo 1:3
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(group: Output<String>? = null, imageUrl: Output<String>? = null, linkUrl: Output<String>? = null, name: Output<String>? = null)

Properties

Link copied to clipboard
val group: Output<String>? = null

The ID or URL-encoded path of the group to add the badge to.

Link copied to clipboard
val imageUrl: Output<String>? = null

The image url which will be presented on group overview.

Link copied to clipboard
val linkUrl: Output<String>? = null

The url linked with the badge.

Link copied to clipboard
val name: Output<String>? = null

The name of the badge.

Functions

Link copied to clipboard
open override fun toJava(): GroupBadgeArgs