Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Github Provider
  3. API Docs
  4. RepositoryCustomProperty
GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi
pulumi/pulumi-github

github.RepositoryCustomProperty

Explore with Pulumi AI

github logo
GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi
pulumi/pulumi-github

    This resource allows you to create and manage a specific custom property for a GitHub repository.

    Example Usage

    Note that this assumes there already is a custom property defined on the org level called my-cool-property of type string

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

const example = new github.Repository("example", {
    name: "example",
    description: "My awesome codebase",
});
const string = new github.RepositoryCustomProperty("string", {
    repository: example.name,
    propertyName: "my-cool-property",
    propertyType: "string",
    propertyValues: ["test"],
});

    import pulumi
import pulumi_github as github

example = github.Repository("example",
    name="example",
    description="My awesome codebase")
string = github.RepositoryCustomProperty("string",
    repository=example.name,
    property_name="my-cool-property",
    property_type="string",
    property_values=["test"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := github.NewRepository(ctx, "example", &github.RepositoryArgs{
			Name:        pulumi.String("example"),
			Description: pulumi.String("My awesome codebase"),
		})
		if err != nil {
			return err
		}
		_, err = github.NewRepositoryCustomProperty(ctx, "string", &github.RepositoryCustomPropertyArgs{
			Repository:   example.Name,
			PropertyName: pulumi.String("my-cool-property"),
			PropertyType: pulumi.String("string"),
			PropertyValues: pulumi.StringArray{
				pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Github.Repository("example", new()
    {
        Name = "example",
        Description = "My awesome codebase",
    });

    var @string = new Github.RepositoryCustomProperty("string", new()
    {
        Repository = example.Name,
        PropertyName = "my-cool-property",
        PropertyType = "string",
        PropertyValues = new[]
        {
            "test",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.Repository;
import com.pulumi.github.RepositoryArgs;
import com.pulumi.github.RepositoryCustomProperty;
import com.pulumi.github.RepositoryCustomPropertyArgs;
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 example = new Repository("example", RepositoryArgs.builder()
            .name("example")
            .description("My awesome codebase")
            .build());

        var string = new RepositoryCustomProperty("string", RepositoryCustomPropertyArgs.builder()
            .repository(example.name())
            .propertyName("my-cool-property")
            .propertyType("string")
            .propertyValues("test")
            .build());

    }
}

    resources:
  example:
    type: github:Repository
    properties:
      name: example
      description: My awesome codebase
  string:
    type: github:RepositoryCustomProperty
    properties:
      repository: ${example.name}
      propertyName: my-cool-property
      propertyType: string
      propertyValues:
        - test

    Create RepositoryCustomProperty Resource

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

    Constructor syntax

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

@overload
def RepositoryCustomProperty(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             property_name: Optional[str] = None,
                             property_type: Optional[str] = None,
                             property_values: Optional[Sequence[str]] = None,
                             repository: Optional[str] = None)
    func NewRepositoryCustomProperty(ctx *Context, name string, args RepositoryCustomPropertyArgs, opts ...ResourceOption) (*RepositoryCustomProperty, error)
    public RepositoryCustomProperty(string name, RepositoryCustomPropertyArgs args, CustomResourceOptions? opts = null)
    public RepositoryCustomProperty(String name, RepositoryCustomPropertyArgs args)
public RepositoryCustomProperty(String name, RepositoryCustomPropertyArgs args, CustomResourceOptions options)

    type: github:RepositoryCustomProperty
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 RepositoryCustomPropertyArgs
    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 RepositoryCustomPropertyArgs
    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 RepositoryCustomPropertyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RepositoryCustomPropertyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RepositoryCustomPropertyArgs
    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 repositoryCustomPropertyResource = new Github.RepositoryCustomProperty("repositoryCustomPropertyResource", new()
{
    PropertyName = "string",
    PropertyType = "string",
    PropertyValues = new[]
    {
        "string",
    },
    Repository = "string",
});

    example, err := github.NewRepositoryCustomProperty(ctx, "repositoryCustomPropertyResource", &github.RepositoryCustomPropertyArgs{
	PropertyName: pulumi.String("string"),
	PropertyType: pulumi.String("string"),
	PropertyValues: pulumi.StringArray{
		pulumi.String("string"),
	},
	Repository: pulumi.String("string"),
})

    var repositoryCustomPropertyResource = new RepositoryCustomProperty("repositoryCustomPropertyResource", RepositoryCustomPropertyArgs.builder()
    .propertyName("string")
    .propertyType("string")
    .propertyValues("string")
    .repository("string")
    .build());

    repository_custom_property_resource = github.RepositoryCustomProperty("repositoryCustomPropertyResource",
    property_name="string",
    property_type="string",
    property_values=["string"],
    repository="string")

    const repositoryCustomPropertyResource = new github.RepositoryCustomProperty("repositoryCustomPropertyResource", {
    propertyName: "string",
    propertyType: "string",
    propertyValues: ["string"],
    repository: "string",
});

    type: github:RepositoryCustomProperty
properties:
    propertyName: string
    propertyType: string
    propertyValues:
        - string
    repository: string

    RepositoryCustomProperty 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 RepositoryCustomProperty resource accepts the following input properties:

    PropertyName string
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    PropertyType string
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    PropertyValues List<string>
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    Repository string
    The repository of the environment.
    PropertyName string
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    PropertyType string
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    PropertyValues []string
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    Repository string
    The repository of the environment.
    propertyName String
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    propertyType String
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    propertyValues List<String>
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    repository String
    The repository of the environment.
    propertyName string
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    propertyType string
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    propertyValues string[]
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    repository string
    The repository of the environment.
    property_name str
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    property_type str
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    property_values Sequence[str]
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    repository str
    The repository of the environment.
    propertyName String
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    propertyType String
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    propertyValues List<String>
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    repository String
    The repository of the environment.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RepositoryCustomProperty Resource

    Get an existing RepositoryCustomProperty 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?: RepositoryCustomPropertyState, opts?: CustomResourceOptions): RepositoryCustomProperty
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        property_name: Optional[str] = None,
        property_type: Optional[str] = None,
        property_values: Optional[Sequence[str]] = None,
        repository: Optional[str] = None) -> RepositoryCustomProperty
    func GetRepositoryCustomProperty(ctx *Context, name string, id IDInput, state *RepositoryCustomPropertyState, opts ...ResourceOption) (*RepositoryCustomProperty, error)
    public static RepositoryCustomProperty Get(string name, Input<string> id, RepositoryCustomPropertyState? state, CustomResourceOptions? opts = null)
    public static RepositoryCustomProperty get(String name, Output<String> id, RepositoryCustomPropertyState state, CustomResourceOptions options)
    resources:  _:    type: github:RepositoryCustomProperty    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:
    PropertyName string
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    PropertyType string
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    PropertyValues List<string>
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    Repository string
    The repository of the environment.
    PropertyName string
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    PropertyType string
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    PropertyValues []string
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    Repository string
    The repository of the environment.
    propertyName String
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    propertyType String
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    propertyValues List<String>
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    repository String
    The repository of the environment.
    propertyName string
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    propertyType string
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    propertyValues string[]
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    repository string
    The repository of the environment.
    property_name str
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    property_type str
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    property_values Sequence[str]
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    repository str
    The repository of the environment.
    propertyName String
    Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
    propertyType String
    Type of the custom property. Can be one of single_select, multi_select, string, or true_false
    propertyValues List<String>
    Value of the custom property in the form of an array. Properties of type single_select, string, and true_false are represented as a string array of length 1
    repository String
    The repository of the environment.

    Import

    GitHub Repository Custom Property can be imported using an ID made up of a comibnation of the names of the organization, repository, custom property separated by a : character, e.g.

    $ pulumi import github:index/repositoryCustomProperty:RepositoryCustomProperty example <organization-name>:<repo-name>:<custom-property-name>

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

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi
    pulumi/pulumi-github