ServiceGithub

NOTE: requires either EE (self-hosted) or Silver and above (GitLab.com).

This resource manages a GitHub integration that updates pipeline statuses on a GitHub repo’s pull requests.

Create a ServiceGithub Resource

new ServiceGithub(name: string, args: ServiceGithubArgs, opts?: CustomResourceOptions);

def ServiceGithub(resource_name, opts=None, project=None, repository_url=None, static_context=None, token=None, __props__=None);

func NewServiceGithub(ctx *Context, name string, args ServiceGithubArgs, opts ...ResourceOption) (*ServiceGithub, error)

public ServiceGithub(string name, ServiceGithubArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ServiceGithubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServiceGithubArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceGithubArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ServiceGithub Resource Properties

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

Inputs

The ServiceGithub resource accepts the following input properties:

Project string: ID of the project you want to activate integration on.
RepositoryUrl string
Token string: A GitHub personal access token with at least repo:status scope.
StaticContext bool: Append instance name instead of branch to the status. Must enable to set a GitLab status check as required in GitHub. See [Static / dynamic status check names] to learn more.

Project string: ID of the project you want to activate integration on.
RepositoryUrl string
Token string: A GitHub personal access token with at least repo:status scope.
StaticContext bool: Append instance name instead of branch to the status. Must enable to set a GitLab status check as required in GitHub. See [Static / dynamic status check names] to learn more.

project string: ID of the project you want to activate integration on.
repositoryUrl string
token string: A GitHub personal access token with at least repo:status scope.
staticContext boolean: Append instance name instead of branch to the status. Must enable to set a GitLab status check as required in GitHub. See [Static / dynamic status check names] to learn more.

project str: ID of the project you want to activate integration on.
repository_url str
token str: A GitHub personal access token with at least repo:status scope.
static_context bool: Append instance name instead of branch to the status. Must enable to set a GitLab status check as required in GitHub. See [Static / dynamic status check names] to learn more.

Outputs

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

Active bool
CreatedAt string
Id string: The provider-assigned unique ID for this managed resource.
Title string
UpdatedAt string

Active bool
CreatedAt string
Id string: The provider-assigned unique ID for this managed resource.
Title string
UpdatedAt string

active boolean
createdAt string
id string: The provider-assigned unique ID for this managed resource.
title string
updatedAt string

active bool
created_at str
id str: The provider-assigned unique ID for this managed resource.
title str
updated_at str

Look up an Existing ServiceGithub Resource

Get an existing ServiceGithub 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?: ServiceGithubState, opts?: CustomResourceOptions): ServiceGithub

static get(resource_name, id, opts=None, active=None, created_at=None, project=None, repository_url=None, static_context=None, title=None, token=None, updated_at=None, __props__=None);

func GetServiceGithub(ctx *Context, name string, id IDInput, state *ServiceGithubState, opts ...ResourceOption) (*ServiceGithub, error)

public static ServiceGithub Get(string name, Input<string> id, ServiceGithubState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Active bool
CreatedAt string
Project string: ID of the project you want to activate integration on.
RepositoryUrl string
StaticContext bool: Append instance name instead of branch to the status. Must enable to set a GitLab status check as required in GitHub. See [Static / dynamic status check names] to learn more.
Title string
Token string: A GitHub personal access token with at least repo:status scope.
UpdatedAt string

Active bool
CreatedAt string
Project string: ID of the project you want to activate integration on.
RepositoryUrl string
StaticContext bool: Append instance name instead of branch to the status. Must enable to set a GitLab status check as required in GitHub. See [Static / dynamic status check names] to learn more.
Title string
Token string: A GitHub personal access token with at least repo:status scope.
UpdatedAt string

active boolean
createdAt string
project string: ID of the project you want to activate integration on.
repositoryUrl string
staticContext boolean: Append instance name instead of branch to the status. Must enable to set a GitLab status check as required in GitHub. See [Static / dynamic status check names] to learn more.
title string
token string: A GitHub personal access token with at least repo:status scope.
updatedAt string

active bool
created_at str
project str: ID of the project you want to activate integration on.
repository_url str
static_context bool: Append instance name instead of branch to the status. Must enable to set a GitLab status check as required in GitHub. See [Static / dynamic status check names] to learn more.
title str
token str: A GitHub personal access token with at least repo:status scope.
updated_at str

Package Details

Repository: https://github.com/pulumi/pulumi-gitlab
License: Apache-2.0
Notes: This Pulumi package is based on the gitlab Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud