1. Packages
  2. GitHub
  3. API Docs
  4. getRepository
GitHub v6.2.2 published on Tuesday, Jun 18, 2024 by Pulumi

github.getRepository

Explore with Pulumi AI

github logo
GitHub v6.2.2 published on Tuesday, Jun 18, 2024 by Pulumi

    Use this data source to retrieve information about a GitHub repository.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const example = github.getRepository({
        fullName: "hashicorp/terraform",
    });
    
    import pulumi
    import pulumi_github as github
    
    example = github.get_repository(full_name="hashicorp/terraform")
    
    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 {
    		_, err := github.LookupRepository(ctx, &github.LookupRepositoryArgs{
    			FullName: pulumi.StringRef("hashicorp/terraform"),
    		}, nil)
    		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 = Github.GetRepository.Invoke(new()
        {
            FullName = "hashicorp/terraform",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.github.GithubFunctions;
    import com.pulumi.github.inputs.GetRepositoryArgs;
    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) {
            final var example = GithubFunctions.getRepository(GetRepositoryArgs.builder()
                .fullName("hashicorp/terraform")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: github:getRepository
          Arguments:
            fullName: hashicorp/terraform
    

    Using getRepository

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRepository(args: GetRepositoryArgs, opts?: InvokeOptions): Promise<GetRepositoryResult>
    function getRepositoryOutput(args: GetRepositoryOutputArgs, opts?: InvokeOptions): Output<GetRepositoryResult>
    def get_repository(description: Optional[str] = None,
                       full_name: Optional[str] = None,
                       homepage_url: Optional[str] = None,
                       name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRepositoryResult
    def get_repository_output(description: Optional[pulumi.Input[str]] = None,
                       full_name: Optional[pulumi.Input[str]] = None,
                       homepage_url: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetRepositoryResult]
    func LookupRepository(ctx *Context, args *LookupRepositoryArgs, opts ...InvokeOption) (*LookupRepositoryResult, error)
    func LookupRepositoryOutput(ctx *Context, args *LookupRepositoryOutputArgs, opts ...InvokeOption) LookupRepositoryResultOutput

    > Note: This function is named LookupRepository in the Go SDK.

    public static class GetRepository 
    {
        public static Task<GetRepositoryResult> InvokeAsync(GetRepositoryArgs args, InvokeOptions? opts = null)
        public static Output<GetRepositoryResult> Invoke(GetRepositoryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRepositoryResult> getRepository(GetRepositoryArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: github:index/getRepository:getRepository
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Description string
    A description of the license.
    FullName string
    Full name of the repository (in org/name format).
    HomepageUrl string
    URL of a page describing the project.
    Name string
    The name of the repository.
    Description string
    A description of the license.
    FullName string
    Full name of the repository (in org/name format).
    HomepageUrl string
    URL of a page describing the project.
    Name string
    The name of the repository.
    description String
    A description of the license.
    fullName String
    Full name of the repository (in org/name format).
    homepageUrl String
    URL of a page describing the project.
    name String
    The name of the repository.
    description string
    A description of the license.
    fullName string
    Full name of the repository (in org/name format).
    homepageUrl string
    URL of a page describing the project.
    name string
    The name of the repository.
    description str
    A description of the license.
    full_name str
    Full name of the repository (in org/name format).
    homepage_url str
    URL of a page describing the project.
    name str
    The name of the repository.
    description String
    A description of the license.
    fullName String
    Full name of the repository (in org/name format).
    homepageUrl String
    URL of a page describing the project.
    name String
    The name of the repository.

    getRepository Result

    The following output properties are available:

    AllowAutoMerge bool
    Whether the repository allows auto-merging pull requests.
    AllowMergeCommit bool
    Whether the repository allows merge commits.
    AllowRebaseMerge bool
    Whether the repository allows rebase merges.
    AllowSquashMerge bool
    Whether the repository allows squash merges.
    Archived bool
    Whether the repository is archived.
    DefaultBranch string
    The name of the default branch of the repository.
    Fork bool
    Whether the repository is a fork.
    FullName string
    GitCloneUrl string
    URL that can be provided to git clone to clone the repository anonymously via the git protocol.
    HasDiscussions bool
    Whether the repository has GitHub Discussions enabled.
    HasDownloads bool
    Whether the repository has Downloads feature enabled.
    HasIssues bool
    Whether the repository has GitHub Issues enabled.
    HasProjects bool
    Whether the repository has the GitHub Projects enabled.
    HasWiki bool
    Whether the repository has the GitHub Wiki enabled.
    HtmlUrl string
    The URL to view the license details on GitHub.
    HttpCloneUrl string
    URL that can be provided to git clone to clone the repository via HTTPS.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsTemplate bool
    Whether the repository is a template repository.
    MergeCommitMessage string
    The default value for a merge commit message.
    MergeCommitTitle string
    The default value for a merge commit title.
    Name string
    The name of the license (e.g., "Apache License 2.0").
    NodeId string
    GraphQL global node id for use with v4 API
    Pages List<GetRepositoryPage>
    The repository's GitHub Pages configuration.
    PrimaryLanguage string
    The primary language used in the repository.
    Private bool
    Whether the repository is private.
    RepoId int
    GitHub ID for the repository
    RepositoryLicenses List<GetRepositoryRepositoryLicense>
    An Array of GitHub repository licenses. Each repository_license block consists of the fields documented below.
    SquashMergeCommitMessage string
    The default value for a squash merge commit message.
    SquashMergeCommitTitle string
    The default value for a squash merge commit title.
    SshCloneUrl string
    URL that can be provided to git clone to clone the repository via SSH.
    SvnUrl string
    URL that can be provided to svn checkout to check out the repository via GitHub's Subversion protocol emulation.
    Templates List<GetRepositoryTemplate>
    The repository source template configuration.
    Topics List<string>
    The list of topics of the repository.
    Visibility string
    Whether the repository is public, private or internal.
    Description string
    A description of the license.
    HomepageUrl string
    URL of a page describing the project.
    AllowAutoMerge bool
    Whether the repository allows auto-merging pull requests.
    AllowMergeCommit bool
    Whether the repository allows merge commits.
    AllowRebaseMerge bool
    Whether the repository allows rebase merges.
    AllowSquashMerge bool
    Whether the repository allows squash merges.
    Archived bool
    Whether the repository is archived.
    DefaultBranch string
    The name of the default branch of the repository.
    Fork bool
    Whether the repository is a fork.
    FullName string
    GitCloneUrl string
    URL that can be provided to git clone to clone the repository anonymously via the git protocol.
    HasDiscussions bool
    Whether the repository has GitHub Discussions enabled.
    HasDownloads bool
    Whether the repository has Downloads feature enabled.
    HasIssues bool
    Whether the repository has GitHub Issues enabled.
    HasProjects bool
    Whether the repository has the GitHub Projects enabled.
    HasWiki bool
    Whether the repository has the GitHub Wiki enabled.
    HtmlUrl string
    The URL to view the license details on GitHub.
    HttpCloneUrl string
    URL that can be provided to git clone to clone the repository via HTTPS.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsTemplate bool
    Whether the repository is a template repository.
    MergeCommitMessage string
    The default value for a merge commit message.
    MergeCommitTitle string
    The default value for a merge commit title.
    Name string
    The name of the license (e.g., "Apache License 2.0").
    NodeId string
    GraphQL global node id for use with v4 API
    Pages []GetRepositoryPage
    The repository's GitHub Pages configuration.
    PrimaryLanguage string
    The primary language used in the repository.
    Private bool
    Whether the repository is private.
    RepoId int
    GitHub ID for the repository
    RepositoryLicenses []GetRepositoryRepositoryLicense
    An Array of GitHub repository licenses. Each repository_license block consists of the fields documented below.
    SquashMergeCommitMessage string
    The default value for a squash merge commit message.
    SquashMergeCommitTitle string
    The default value for a squash merge commit title.
    SshCloneUrl string
    URL that can be provided to git clone to clone the repository via SSH.
    SvnUrl string
    URL that can be provided to svn checkout to check out the repository via GitHub's Subversion protocol emulation.
    Templates []GetRepositoryTemplate
    The repository source template configuration.
    Topics []string
    The list of topics of the repository.
    Visibility string
    Whether the repository is public, private or internal.
    Description string
    A description of the license.
    HomepageUrl string
    URL of a page describing the project.
    allowAutoMerge Boolean
    Whether the repository allows auto-merging pull requests.
    allowMergeCommit Boolean
    Whether the repository allows merge commits.
    allowRebaseMerge Boolean
    Whether the repository allows rebase merges.
    allowSquashMerge Boolean
    Whether the repository allows squash merges.
    archived Boolean
    Whether the repository is archived.
    defaultBranch String
    The name of the default branch of the repository.
    fork Boolean
    Whether the repository is a fork.
    fullName String
    gitCloneUrl String
    URL that can be provided to git clone to clone the repository anonymously via the git protocol.
    hasDiscussions Boolean
    Whether the repository has GitHub Discussions enabled.
    hasDownloads Boolean
    Whether the repository has Downloads feature enabled.
    hasIssues Boolean
    Whether the repository has GitHub Issues enabled.
    hasProjects Boolean
    Whether the repository has the GitHub Projects enabled.
    hasWiki Boolean
    Whether the repository has the GitHub Wiki enabled.
    htmlUrl String
    The URL to view the license details on GitHub.
    httpCloneUrl String
    URL that can be provided to git clone to clone the repository via HTTPS.
    id String
    The provider-assigned unique ID for this managed resource.
    isTemplate Boolean
    Whether the repository is a template repository.
    mergeCommitMessage String
    The default value for a merge commit message.
    mergeCommitTitle String
    The default value for a merge commit title.
    name String
    The name of the license (e.g., "Apache License 2.0").
    nodeId String
    GraphQL global node id for use with v4 API
    pages List<GetRepositoryPage>
    The repository's GitHub Pages configuration.
    primaryLanguage String
    The primary language used in the repository.
    private_ Boolean
    Whether the repository is private.
    repoId Integer
    GitHub ID for the repository
    repositoryLicenses List<GetRepositoryRepositoryLicense>
    An Array of GitHub repository licenses. Each repository_license block consists of the fields documented below.
    squashMergeCommitMessage String
    The default value for a squash merge commit message.
    squashMergeCommitTitle String
    The default value for a squash merge commit title.
    sshCloneUrl String
    URL that can be provided to git clone to clone the repository via SSH.
    svnUrl String
    URL that can be provided to svn checkout to check out the repository via GitHub's Subversion protocol emulation.
    templates List<GetRepositoryTemplate>
    The repository source template configuration.
    topics List<String>
    The list of topics of the repository.
    visibility String
    Whether the repository is public, private or internal.
    description String
    A description of the license.
    homepageUrl String
    URL of a page describing the project.
    allowAutoMerge boolean
    Whether the repository allows auto-merging pull requests.
    allowMergeCommit boolean
    Whether the repository allows merge commits.
    allowRebaseMerge boolean
    Whether the repository allows rebase merges.
    allowSquashMerge boolean
    Whether the repository allows squash merges.
    archived boolean
    Whether the repository is archived.
    defaultBranch string
    The name of the default branch of the repository.
    fork boolean
    Whether the repository is a fork.
    fullName string
    gitCloneUrl string
    URL that can be provided to git clone to clone the repository anonymously via the git protocol.
    hasDiscussions boolean
    Whether the repository has GitHub Discussions enabled.
    hasDownloads boolean
    Whether the repository has Downloads feature enabled.
    hasIssues boolean
    Whether the repository has GitHub Issues enabled.
    hasProjects boolean
    Whether the repository has the GitHub Projects enabled.
    hasWiki boolean
    Whether the repository has the GitHub Wiki enabled.
    htmlUrl string
    The URL to view the license details on GitHub.
    httpCloneUrl string
    URL that can be provided to git clone to clone the repository via HTTPS.
    id string
    The provider-assigned unique ID for this managed resource.
    isTemplate boolean
    Whether the repository is a template repository.
    mergeCommitMessage string
    The default value for a merge commit message.
    mergeCommitTitle string
    The default value for a merge commit title.
    name string
    The name of the license (e.g., "Apache License 2.0").
    nodeId string
    GraphQL global node id for use with v4 API
    pages GetRepositoryPage[]
    The repository's GitHub Pages configuration.
    primaryLanguage string
    The primary language used in the repository.
    private boolean
    Whether the repository is private.
    repoId number
    GitHub ID for the repository
    repositoryLicenses GetRepositoryRepositoryLicense[]
    An Array of GitHub repository licenses. Each repository_license block consists of the fields documented below.
    squashMergeCommitMessage string
    The default value for a squash merge commit message.
    squashMergeCommitTitle string
    The default value for a squash merge commit title.
    sshCloneUrl string
    URL that can be provided to git clone to clone the repository via SSH.
    svnUrl string
    URL that can be provided to svn checkout to check out the repository via GitHub's Subversion protocol emulation.
    templates GetRepositoryTemplate[]
    The repository source template configuration.
    topics string[]
    The list of topics of the repository.
    visibility string
    Whether the repository is public, private or internal.
    description string
    A description of the license.
    homepageUrl string
    URL of a page describing the project.
    allow_auto_merge bool
    Whether the repository allows auto-merging pull requests.
    allow_merge_commit bool
    Whether the repository allows merge commits.
    allow_rebase_merge bool
    Whether the repository allows rebase merges.
    allow_squash_merge bool
    Whether the repository allows squash merges.
    archived bool
    Whether the repository is archived.
    default_branch str
    The name of the default branch of the repository.
    fork bool
    Whether the repository is a fork.
    full_name str
    git_clone_url str
    URL that can be provided to git clone to clone the repository anonymously via the git protocol.
    has_discussions bool
    Whether the repository has GitHub Discussions enabled.
    has_downloads bool
    Whether the repository has Downloads feature enabled.
    has_issues bool
    Whether the repository has GitHub Issues enabled.
    has_projects bool
    Whether the repository has the GitHub Projects enabled.
    has_wiki bool
    Whether the repository has the GitHub Wiki enabled.
    html_url str
    The URL to view the license details on GitHub.
    http_clone_url str
    URL that can be provided to git clone to clone the repository via HTTPS.
    id str
    The provider-assigned unique ID for this managed resource.
    is_template bool
    Whether the repository is a template repository.
    merge_commit_message str
    The default value for a merge commit message.
    merge_commit_title str
    The default value for a merge commit title.
    name str
    The name of the license (e.g., "Apache License 2.0").
    node_id str
    GraphQL global node id for use with v4 API
    pages Sequence[GetRepositoryPage]
    The repository's GitHub Pages configuration.
    primary_language str
    The primary language used in the repository.
    private bool
    Whether the repository is private.
    repo_id int
    GitHub ID for the repository
    repository_licenses Sequence[GetRepositoryRepositoryLicense]
    An Array of GitHub repository licenses. Each repository_license block consists of the fields documented below.
    squash_merge_commit_message str
    The default value for a squash merge commit message.
    squash_merge_commit_title str
    The default value for a squash merge commit title.
    ssh_clone_url str
    URL that can be provided to git clone to clone the repository via SSH.
    svn_url str
    URL that can be provided to svn checkout to check out the repository via GitHub's Subversion protocol emulation.
    templates Sequence[GetRepositoryTemplate]
    The repository source template configuration.
    topics Sequence[str]
    The list of topics of the repository.
    visibility str
    Whether the repository is public, private or internal.
    description str
    A description of the license.
    homepage_url str
    URL of a page describing the project.
    allowAutoMerge Boolean
    Whether the repository allows auto-merging pull requests.
    allowMergeCommit Boolean
    Whether the repository allows merge commits.
    allowRebaseMerge Boolean
    Whether the repository allows rebase merges.
    allowSquashMerge Boolean
    Whether the repository allows squash merges.
    archived Boolean
    Whether the repository is archived.
    defaultBranch String
    The name of the default branch of the repository.
    fork Boolean
    Whether the repository is a fork.
    fullName String
    gitCloneUrl String
    URL that can be provided to git clone to clone the repository anonymously via the git protocol.
    hasDiscussions Boolean
    Whether the repository has GitHub Discussions enabled.
    hasDownloads Boolean
    Whether the repository has Downloads feature enabled.
    hasIssues Boolean
    Whether the repository has GitHub Issues enabled.
    hasProjects Boolean
    Whether the repository has the GitHub Projects enabled.
    hasWiki Boolean
    Whether the repository has the GitHub Wiki enabled.
    htmlUrl String
    The URL to view the license details on GitHub.
    httpCloneUrl String
    URL that can be provided to git clone to clone the repository via HTTPS.
    id String
    The provider-assigned unique ID for this managed resource.
    isTemplate Boolean
    Whether the repository is a template repository.
    mergeCommitMessage String
    The default value for a merge commit message.
    mergeCommitTitle String
    The default value for a merge commit title.
    name String
    The name of the license (e.g., "Apache License 2.0").
    nodeId String
    GraphQL global node id for use with v4 API
    pages List<Property Map>
    The repository's GitHub Pages configuration.
    primaryLanguage String
    The primary language used in the repository.
    private Boolean
    Whether the repository is private.
    repoId Number
    GitHub ID for the repository
    repositoryLicenses List<Property Map>
    An Array of GitHub repository licenses. Each repository_license block consists of the fields documented below.
    squashMergeCommitMessage String
    The default value for a squash merge commit message.
    squashMergeCommitTitle String
    The default value for a squash merge commit title.
    sshCloneUrl String
    URL that can be provided to git clone to clone the repository via SSH.
    svnUrl String
    URL that can be provided to svn checkout to check out the repository via GitHub's Subversion protocol emulation.
    templates List<Property Map>
    The repository source template configuration.
    topics List<String>
    The list of topics of the repository.
    visibility String
    Whether the repository is public, private or internal.
    description String
    A description of the license.
    homepageUrl String
    URL of a page describing the project.

    Supporting Types

    GetRepositoryPage

    BuildType string
    Cname string
    Custom404 bool
    HtmlUrl string
    The URL to view the license details on GitHub.
    Sources List<GetRepositoryPageSource>
    Status string
    Url string
    The URL to access information about the license on GitHub.
    BuildType string
    Cname string
    Custom404 bool
    HtmlUrl string
    The URL to view the license details on GitHub.
    Sources []GetRepositoryPageSource
    Status string
    Url string
    The URL to access information about the license on GitHub.
    buildType String
    cname String
    custom404 Boolean
    htmlUrl String
    The URL to view the license details on GitHub.
    sources List<GetRepositoryPageSource>
    status String
    url String
    The URL to access information about the license on GitHub.
    buildType string
    cname string
    custom404 boolean
    htmlUrl string
    The URL to view the license details on GitHub.
    sources GetRepositoryPageSource[]
    status string
    url string
    The URL to access information about the license on GitHub.
    build_type str
    cname str
    custom404 bool
    html_url str
    The URL to view the license details on GitHub.
    sources Sequence[GetRepositoryPageSource]
    status str
    url str
    The URL to access information about the license on GitHub.
    buildType String
    cname String
    custom404 Boolean
    htmlUrl String
    The URL to view the license details on GitHub.
    sources List<Property Map>
    status String
    url String
    The URL to access information about the license on GitHub.

    GetRepositoryPageSource

    Branch string
    Path string
    The path to the license file within the repository.
    Branch string
    Path string
    The path to the license file within the repository.
    branch String
    path String
    The path to the license file within the repository.
    branch string
    path string
    The path to the license file within the repository.
    branch str
    path str
    The path to the license file within the repository.
    branch String
    path String
    The path to the license file within the repository.

    GetRepositoryRepositoryLicense

    Content string
    Content of the license file, encoded by encoding scheme mentioned below.
    DownloadUrl string
    The URL to download the raw content of the license file.
    Encoding string
    The encoding used for the content (e.g., "base64").
    GitUrl string
    The URL to access information about the license file as a Git blob.
    HtmlUrl string
    The URL to view the license details on GitHub.
    Licenses List<GetRepositoryRepositoryLicenseLicense>
    license block consists of the fields documented below.
    Name string
    The name of the repository.
    Path string
    The path to the license file within the repository.
    Sha string
    The SHA hash of the license file.
    Size int
    The size of the license file in bytes.
    Type string
    The type of the content, (e.g., "file").
    Url string
    The URL to access information about the license on GitHub.
    Content string
    Content of the license file, encoded by encoding scheme mentioned below.
    DownloadUrl string
    The URL to download the raw content of the license file.
    Encoding string
    The encoding used for the content (e.g., "base64").
    GitUrl string
    The URL to access information about the license file as a Git blob.
    HtmlUrl string
    The URL to view the license details on GitHub.
    Licenses []GetRepositoryRepositoryLicenseLicense
    license block consists of the fields documented below.
    Name string
    The name of the repository.
    Path string
    The path to the license file within the repository.
    Sha string
    The SHA hash of the license file.
    Size int
    The size of the license file in bytes.
    Type string
    The type of the content, (e.g., "file").
    Url string
    The URL to access information about the license on GitHub.
    content String
    Content of the license file, encoded by encoding scheme mentioned below.
    downloadUrl String
    The URL to download the raw content of the license file.
    encoding String
    The encoding used for the content (e.g., "base64").
    gitUrl String
    The URL to access information about the license file as a Git blob.
    htmlUrl String
    The URL to view the license details on GitHub.
    licenses List<GetRepositoryRepositoryLicenseLicense>
    license block consists of the fields documented below.
    name String
    The name of the repository.
    path String
    The path to the license file within the repository.
    sha String
    The SHA hash of the license file.
    size Integer
    The size of the license file in bytes.
    type String
    The type of the content, (e.g., "file").
    url String
    The URL to access information about the license on GitHub.
    content string
    Content of the license file, encoded by encoding scheme mentioned below.
    downloadUrl string
    The URL to download the raw content of the license file.
    encoding string
    The encoding used for the content (e.g., "base64").
    gitUrl string
    The URL to access information about the license file as a Git blob.
    htmlUrl string
    The URL to view the license details on GitHub.
    licenses GetRepositoryRepositoryLicenseLicense[]
    license block consists of the fields documented below.
    name string
    The name of the repository.
    path string
    The path to the license file within the repository.
    sha string
    The SHA hash of the license file.
    size number
    The size of the license file in bytes.
    type string
    The type of the content, (e.g., "file").
    url string
    The URL to access information about the license on GitHub.
    content str
    Content of the license file, encoded by encoding scheme mentioned below.
    download_url str
    The URL to download the raw content of the license file.
    encoding str
    The encoding used for the content (e.g., "base64").
    git_url str
    The URL to access information about the license file as a Git blob.
    html_url str
    The URL to view the license details on GitHub.
    licenses Sequence[GetRepositoryRepositoryLicenseLicense]
    license block consists of the fields documented below.
    name str
    The name of the repository.
    path str
    The path to the license file within the repository.
    sha str
    The SHA hash of the license file.
    size int
    The size of the license file in bytes.
    type str
    The type of the content, (e.g., "file").
    url str
    The URL to access information about the license on GitHub.
    content String
    Content of the license file, encoded by encoding scheme mentioned below.
    downloadUrl String
    The URL to download the raw content of the license file.
    encoding String
    The encoding used for the content (e.g., "base64").
    gitUrl String
    The URL to access information about the license file as a Git blob.
    htmlUrl String
    The URL to view the license details on GitHub.
    licenses List<Property Map>
    license block consists of the fields documented below.
    name String
    The name of the repository.
    path String
    The path to the license file within the repository.
    sha String
    The SHA hash of the license file.
    size Number
    The size of the license file in bytes.
    type String
    The type of the content, (e.g., "file").
    url String
    The URL to access information about the license on GitHub.

    GetRepositoryRepositoryLicenseLicense

    Body string
    The text of the license.
    Conditions List<string>
    Conditions associated with the license.
    Description string
    A description of the license.
    Featured bool
    Indicates if the license is featured.
    HtmlUrl string
    The URL to view the license details on GitHub.
    Implementation string
    Details about the implementation of the license.
    Key string
    A key representing the license type (e.g., "apache-2.0").
    Limitations List<string>
    Limitations associated with the license.
    Name string
    The name of the repository.
    Permissions List<string>
    Permissions associated with the license.
    SpdxId string
    The SPDX identifier for the license (e.g., "Apache-2.0").
    Url string
    The URL to access information about the license on GitHub.
    Body string
    The text of the license.
    Conditions []string
    Conditions associated with the license.
    Description string
    A description of the license.
    Featured bool
    Indicates if the license is featured.
    HtmlUrl string
    The URL to view the license details on GitHub.
    Implementation string
    Details about the implementation of the license.
    Key string
    A key representing the license type (e.g., "apache-2.0").
    Limitations []string
    Limitations associated with the license.
    Name string
    The name of the repository.
    Permissions []string
    Permissions associated with the license.
    SpdxId string
    The SPDX identifier for the license (e.g., "Apache-2.0").
    Url string
    The URL to access information about the license on GitHub.
    body String
    The text of the license.
    conditions List<String>
    Conditions associated with the license.
    description String
    A description of the license.
    featured Boolean
    Indicates if the license is featured.
    htmlUrl String
    The URL to view the license details on GitHub.
    implementation String
    Details about the implementation of the license.
    key String
    A key representing the license type (e.g., "apache-2.0").
    limitations List<String>
    Limitations associated with the license.
    name String
    The name of the repository.
    permissions List<String>
    Permissions associated with the license.
    spdxId String
    The SPDX identifier for the license (e.g., "Apache-2.0").
    url String
    The URL to access information about the license on GitHub.
    body string
    The text of the license.
    conditions string[]
    Conditions associated with the license.
    description string
    A description of the license.
    featured boolean
    Indicates if the license is featured.
    htmlUrl string
    The URL to view the license details on GitHub.
    implementation string
    Details about the implementation of the license.
    key string
    A key representing the license type (e.g., "apache-2.0").
    limitations string[]
    Limitations associated with the license.
    name string
    The name of the repository.
    permissions string[]
    Permissions associated with the license.
    spdxId string
    The SPDX identifier for the license (e.g., "Apache-2.0").
    url string
    The URL to access information about the license on GitHub.
    body str
    The text of the license.
    conditions Sequence[str]
    Conditions associated with the license.
    description str
    A description of the license.
    featured bool
    Indicates if the license is featured.
    html_url str
    The URL to view the license details on GitHub.
    implementation str
    Details about the implementation of the license.
    key str
    A key representing the license type (e.g., "apache-2.0").
    limitations Sequence[str]
    Limitations associated with the license.
    name str
    The name of the repository.
    permissions Sequence[str]
    Permissions associated with the license.
    spdx_id str
    The SPDX identifier for the license (e.g., "Apache-2.0").
    url str
    The URL to access information about the license on GitHub.
    body String
    The text of the license.
    conditions List<String>
    Conditions associated with the license.
    description String
    A description of the license.
    featured Boolean
    Indicates if the license is featured.
    htmlUrl String
    The URL to view the license details on GitHub.
    implementation String
    Details about the implementation of the license.
    key String
    A key representing the license type (e.g., "apache-2.0").
    limitations List<String>
    Limitations associated with the license.
    name String
    The name of the repository.
    permissions List<String>
    Permissions associated with the license.
    spdxId String
    The SPDX identifier for the license (e.g., "Apache-2.0").
    url String
    The URL to access information about the license on GitHub.

    GetRepositoryTemplate

    Owner string
    Repository string
    Owner string
    Repository string
    owner String
    repository String
    owner string
    repository string
    owner String
    repository String

    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.2.2 published on Tuesday, Jun 18, 2024 by Pulumi