Viewing docs for GitHub v4.17.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
published on Monday, Mar 9, 2026 by Pulumi
Viewing docs for GitHub v4.17.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
published on Monday, Mar 9, 2026 by Pulumi
Note: The data source will return a maximum of
1000repositories as documented in official API docs.
Use this data source to retrieve a list of GitHub repositories using a search query.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var example = Github.GetRepositories.Invoke(new()
{
Query = "org:hashicorp language:Go",
});
});
package main
import (
"github.com/pulumi/pulumi-github/sdk/v4/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := github.GetRepositories(ctx, &GetRepositoriesArgs{
Query: "org:hashicorp language:Go",
}, nil)
if err != nil {
return err
}
return nil
})
}
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.GetRepositoriesArgs;
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.getRepositories(GetRepositoriesArgs.builder()
.query("org:hashicorp language:Go")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const example = pulumi.output(github.getRepositories({
query: "org:hashicorp language:Go",
}));
import pulumi
import pulumi_github as github
example = github.get_repositories(query="org:hashicorp language:Go")
variables:
example:
Fn::Invoke:
Function: github:getRepositories
Arguments:
query: org:hashicorp language:Go
Using getRepositories
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 getRepositories(args: GetRepositoriesArgs, opts?: InvokeOptions): Promise<GetRepositoriesResult>
function getRepositoriesOutput(args: GetRepositoriesOutputArgs, opts?: InvokeOptions): Output<GetRepositoriesResult>def get_repositories(query: Optional[str] = None,
sort: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetRepositoriesResult
def get_repositories_output(query: Optional[pulumi.Input[str]] = None,
sort: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetRepositoriesResult]func GetRepositories(ctx *Context, args *GetRepositoriesArgs, opts ...InvokeOption) (*GetRepositoriesResult, error)
func GetRepositoriesOutput(ctx *Context, args *GetRepositoriesOutputArgs, opts ...InvokeOption) GetRepositoriesResultOutput> Note: This function is named GetRepositories in the Go SDK.
public static class GetRepositories
{
public static Task<GetRepositoriesResult> InvokeAsync(GetRepositoriesArgs args, InvokeOptions? opts = null)
public static Output<GetRepositoriesResult> Invoke(GetRepositoriesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetRepositoriesResult> getRepositories(GetRepositoriesArgs args, InvokeOptions options)
public static Output<GetRepositoriesResult> getRepositories(GetRepositoriesArgs args, InvokeOptions options)
fn::invoke:
function: github:index/getRepositories:getRepositories
arguments:
# arguments dictionaryThe 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, andupdated. Defaults toupdated.
- 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, andupdated. Defaults toupdated.
- 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, andupdated. Defaults toupdated.
- 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, andupdated. Defaults toupdated.
- 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, andupdated. Defaults toupdated.
- 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, andupdated. Defaults toupdated.
getRepositories Result
The following output properties are available:
- full_
names Sequence[str] - id str
- The provider-assigned unique ID for this managed resource.
- names Sequence[str]
- query str
- sort str
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
githubTerraform Provider.
Viewing docs for GitHub v4.17.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
published on Monday, Mar 9, 2026 by Pulumi
