1. Docs
  2. Reference
  3. API
  4. GitHub
  5. GetRepositories

GetRepositories

Note: The data source will return a maximum of 1000 repositories as documented in official API docs.

Use this data source to retrieve a list of GitHub repositories using a search query.

Example Usage

using Pulumi;
using Github = Pulumi.Github;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Github.GetRepositories.InvokeAsync(new Github.GetRepositoriesArgs
        {
            Query = "org:hashicorp language:Go",
        }));
    }

}

Coming soon!

import pulumi
import pulumi_github as github

example = github.get_repositories(query="org:hashicorp language:Go")
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const example = pulumi.output(github.getRepositories({
    query: "org:hashicorp language:Go",
}, { async: true }));

Using GetRepositories

function getRepositories(args: GetRepositoriesArgs, opts?: InvokeOptions): Promise<GetRepositoriesResult>
function  get_repositories(query=None, sort=None, opts=None)
func GetRepositories(ctx *Context, args *GetRepositoriesArgs, opts ...InvokeOption) (*GetRepositoriesResult, error)
public static class GetRepositories {
    public static Task<GetRepositoriesResult> InvokeAsync(GetRepositoriesArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Query string

Search query. See documentation for the search syntax.

Sort string

Sorts the repositories returned by the specified attribute. Valid values include stars, fork, and updated. Defaults to updated.

Query string

Search query. See documentation for the search syntax.

Sort string

Sorts the repositories returned by the specified attribute. Valid values include stars, fork, and updated. Defaults to updated.

query string

Search query. See documentation for the search syntax.

sort string

Sorts the repositories returned by the specified attribute. Valid values include stars, fork, and updated. Defaults to updated.

query str

Search query. See documentation for the search syntax.

sort str

Sorts the repositories returned by the specified attribute. Valid values include stars, fork, and updated. Defaults to updated.

GetRepositories Result

The following output properties are available:

FullNames List<string>
Id string

The provider-assigned unique ID for this managed resource.

Names List<string>
Query string
Sort string
FullNames []string
Id string

The provider-assigned unique ID for this managed resource.

Names []string
Query string
Sort string
fullNames string[]
id string

The provider-assigned unique ID for this managed resource.

names string[]
query string
sort string
full_names List[str]
id str

The provider-assigned unique ID for this managed resource.

names List[str]
query str
sort str

Package Details

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