Class Repository

Inheritance

System.Object

Resource

CustomResource

Repository

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Github

Assembly: Pulumi.Github.dll

Syntax

public class Repository : CustomResource

Constructors

Repository(String, RepositoryArgs, CustomResourceOptions)

Create a Repository resource with the given unique name, arguments, and options.

Declaration

public Repository(string name, RepositoryArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
RepositoryArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AllowMergeCommit

Set to false to disable merge commits on the repository.

Declaration

public Output<bool?> AllowMergeCommit { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

AllowRebaseMerge

Set to false to disable rebase merges on the repository.

Declaration

public Output<bool?> AllowRebaseMerge { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

AllowSquashMerge

Set to false to disable squash merges on the repository.

Declaration

public Output<bool?> AllowSquashMerge { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Archived

Specifies if the repository should be archived. Defaults to false. NOTE Currently, the API does not support unarchiving.

Declaration

public Output<bool?> Archived { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

AutoInit

Set to true to produce an initial commit in the repository.

Declaration

public Output<bool?> AutoInit { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

DefaultBranch

The name of the default branch of the repository. NOTE: This can only be set after a repository has already been created, and after a correct reference has been created for the target branch inside the repository. This means a user will have to omit this parameter from the initial repository creation and create the target branch inside of the repository prior to setting this attribute.

Declaration

public Output<string> DefaultBranch { get; }

Property Value

Type	Description
Output<System.String>

DeleteBranchOnMerge

Automatically delete head branch after a pull request is merged. Defaults to false.

Declaration

public Output<bool?> DeleteBranchOnMerge { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Description

A description of the repository.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Etag

Declaration

public Output<string> Etag { get; }

Property Value

Type	Description
Output<System.String>

FullName

A string of the form "orgname/reponame".

Declaration

public Output<string> FullName { get; }

Property Value

Type	Description
Output<System.String>

GitCloneUrl

URL that can be provided to git clone to clone the repository anonymously via the git protocol.

Declaration

public Output<string> GitCloneUrl { get; }

Property Value

Type	Description
Output<System.String>

GitignoreTemplate

Use the name of the template without the extension. For example, "Haskell".

Declaration

public Output<string> GitignoreTemplate { get; }

Property Value

Type	Description
Output<System.String>

HasDownloads

Set to true to enable the (deprecated) downloads features on the repository.

Declaration

public Output<bool?> HasDownloads { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

HasIssues

Set to true to enable the GitHub Issues features on the repository.

Declaration

public Output<bool?> HasIssues { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

HasProjects

Set to true to enable the GitHub Projects features on the repository. Per the GitHub documentation when in an organization that has disabled repository projects it will default to false and will otherwise default to true. If you specify true when it has been disabled it will return an error.

Declaration

public Output<bool?> HasProjects { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

HasWiki

Set to true to enable the GitHub Wiki features on the repository.

Declaration

public Output<bool?> HasWiki { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

HomepageUrl

URL of a page describing the project.

Declaration

public Output<string> HomepageUrl { get; }

Property Value

Type	Description
Output<System.String>

HtmlUrl

URL to the repository on the web.

Declaration

public Output<string> HtmlUrl { get; }

Property Value

Type	Description
Output<System.String>

HttpCloneUrl

URL that can be provided to git clone to clone the repository via HTTPS.

Declaration

public Output<string> HttpCloneUrl { get; }

Property Value

Type	Description
Output<System.String>

IsTemplate

Set to true to tell GitHub that this is a template repository.

Declaration

public Output<bool?> IsTemplate { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

LicenseTemplate

Use the name of the template without the extension. For example, "mit" or "mpl-2.0".

Declaration

public Output<string> LicenseTemplate { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the repository.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NodeId

Declaration

public Output<string> NodeId { get; }

Property Value

Type	Description
Output<System.String>

Private

Set to true to create a private repository. Repositories are created as public (e.g. open source) by default.

Declaration

public Output<bool?> Private { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

SshCloneUrl

URL that can be provided to git clone to clone the repository via SSH.

Declaration

public Output<string> SshCloneUrl { get; }

Property Value

Type	Description
Output<System.String>

SvnUrl

URL that can be provided to svn checkout to check out the repository via GitHub's Subversion protocol emulation.

Declaration

public Output<string> SvnUrl { get; }

Property Value

Type	Description
Output<System.String>

Template

Use a template repository to create this resource. See Template Repositories below for details.

Declaration

public Output<RepositoryTemplate> Template { get; }

Property Value

Type	Description
Output<RepositoryTemplate>

Topics

The list of topics of the repository.

Declaration

public Output<ImmutableArray<string>> Topics { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Methods

Get(String, Input<String>, RepositoryState, CustomResourceOptions)

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

Declaration

public static Repository Get(string name, Input<string> id, RepositoryState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
RepositoryState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Repository