GithubFunctions

Functions

Link copied to clipboard

Use this data source to retrieve the list of secrets of the repository environment.

suspend fun getActionsEnvironmentSecrets(environment: String, fullName: String? = null, name: String? = null): GetActionsEnvironmentSecretsResult
Link copied to clipboard

Use this data source to retrieve the list of variables of the repository environment.

suspend fun getActionsEnvironmentVariables(environment: String, fullName: String? = null, name: String? = null): GetActionsEnvironmentVariablesResult

Use this data source to retrieve the OpenID Connect subject claim customization template for an organization

Link copied to clipboard

Use this data source to retrieve information about a GitHub Actions Organization public key. This data source is required to be used with other GitHub secrets interactions. Note that the provider token must have admin rights to an organization to retrieve it's action public key.

Link copied to clipboard

Use this data source to retrieve a GitHub Actions organization registration token. This token can then be used to register a self-hosted runner.

Link copied to clipboard

Use this data source to retrieve the list of secrets of the organization.

Link copied to clipboard

Use this data source to retrieve the list of variables of the organization.

Link copied to clipboard

Use this data source to retrieve information about a GitHub Actions public key. This data source is required to be used with other GitHub secrets interactions. Note that the provider token must have admin rights to a repository to retrieve it's action public key.

Link copied to clipboard

Use this data source to retrieve a GitHub Actions repository registration token. This token can then be used to register a self-hosted runner.

Link copied to clipboard

Use this data source to retrieve the list of secrets for a GitHub repository.

suspend fun getActionsSecrets(fullName: String? = null, name: String? = null): GetActionsSecretsResult
Link copied to clipboard

Use this data source to retrieve the list of variables for a GitHub repository.

suspend fun getActionsVariables(fullName: String? = null, name: String? = null): GetActionsVariablesResult
Link copied to clipboard

Use this data source to generate a GitHub App JWT.

suspend fun getAppToken(argument: suspend GetAppTokenPlainArgsBuilder.() -> Unit): GetAppTokenResult
suspend fun getAppToken(appId: String, installationId: String, pemFile: String): GetAppTokenResult
Link copied to clipboard

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

suspend fun getBranch(argument: suspend GetBranchPlainArgsBuilder.() -> Unit): GetBranchResult
suspend fun getBranch(branch: String, repository: String): GetBranchResult
Link copied to clipboard

Use this data source to retrieve a list of repository branch protection rules.

Link copied to clipboard

Use this data source to retrieve information about a GitHub Codespaces Organization public key. This data source is required to be used with other GitHub secrets interactions. Note that the provider token must have admin rights to an organization to retrieve it's Codespaces public key.

Link copied to clipboard

Use this data source to retrieve the list of codespaces secrets of the organization.

Link copied to clipboard

Use this data source to retrieve information about a GitHub Codespaces public key. This data source is required to be used with other GitHub secrets interactions. Note that the provider token must have admin rights to a repository to retrieve it's Codespaces public key.

Link copied to clipboard

Use this data source to retrieve the list of codespaces secrets for a GitHub repository.

suspend fun getCodespacesSecrets(fullName: String? = null, name: String? = null): GetCodespacesSecretsResult
Link copied to clipboard

Use this data source to retrieve information about a GitHub Codespaces User public key. This data source is required to be used with other GitHub secrets interactions. Note that the provider token must have admin rights to an user to retrieve it's Codespaces public key.

Link copied to clipboard

Use this data source to retrieve the list of codespaces secrets of the user.

Link copied to clipboard

Use this data source to retrieve the collaborators for a given repository.

suspend fun getCollaborators(affiliation: String? = null, owner: String, permission: String? = null, repository: String): GetCollaboratorsResult
Link copied to clipboard

Use this data source to retrieve information about a GitHub Dependabot Organization public key. This data source is required to be used with other GitHub secrets interactions. Note that the provider token must have admin rights to an organization to retrieve it's Dependabot public key.

Link copied to clipboard

Use this data source to retrieve the list of dependabot secrets of the organization.

Link copied to clipboard

Use this data source to retrieve information about a GitHub Dependabot public key. This data source is required to be used with other GitHub secrets interactions. Note that the provider token must have admin rights to a repository to retrieve it's Dependabot public key.

Link copied to clipboard

Use this data source to retrieve the list of dependabot secrets for a GitHub repository.

suspend fun getDependabotSecrets(fullName: String? = null, name: String? = null): GetDependabotSecretsResult
Link copied to clipboard

Use this data source to retrieve basic information about a GitHub enterprise.

Link copied to clipboard

Use this data source to retrieve external groups belonging to an organization.

Link copied to clipboard

Use this data source to retrieve information about an app.

Link copied to clipboard

Use this data source to retrieve information about GitHub's IP addresses.

Link copied to clipboard

Use this data source to retrieve the labels for a given repository.

suspend fun getIssueLabels(repository: String): GetIssueLabelsResult
Link copied to clipboard

Use this data source to find out if a user is a member of your organization, as well as what role they have within it. If the user's membership in the organization is pending their acceptance of an invite, the role they would have once they accept will be returned.

suspend fun getMembership(organization: String? = null, username: String): GetMembershipResult
Link copied to clipboard

Use this data source to retrieve basic information about a GitHub Organization.

suspend fun getOrganization(ignoreArchivedRepos: Boolean? = null, name: String, summaryOnly: Boolean? = null): GetOrganizationResult
Link copied to clipboard

Use this data source to retrieve information about a custom role in a GitHub Organization.

Link copied to clipboard

Use this data source to retrieve each organization member's SAML or SCIM user attributes.

Link copied to clipboard

Use this data source to retrieve information about the IP allow list of an organization. The allow list for IP addresses will block access to private resources via the web, API, and Git from any IP addresses that are not on the allow list.

Link copied to clipboard

Use this data source to retrieve information about all GitHub teams in an organization.

suspend fun getOrganizationTeams(resultsPerPage: Int? = null, rootTeamsOnly: Boolean? = null, summaryOnly: Boolean? = null): GetOrganizationTeamsResult
Link copied to clipboard

Use this data source to retrieve the identity provider (IdP) groups for an organization.

Link copied to clipboard

Use this data source to retrieve all webhooks of the organization.

Link copied to clipboard
suspend fun getRef(argument: GetRefPlainArgs): GetRefResult

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

suspend fun getRef(argument: suspend GetRefPlainArgsBuilder.() -> Unit): GetRefResult
suspend fun getRef(owner: String? = null, ref: String, repository: String): GetRefResult
Link copied to clipboard

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

suspend fun getRelease(argument: suspend GetReleasePlainArgsBuilder.() -> Unit): GetReleaseResult
suspend fun getRelease(owner: String, releaseId: Int? = null, releaseTag: String? = null, repository: String, retrieveBy: String): GetReleaseResult
Link copied to clipboard
suspend fun getRepositories(includeRepoId: Boolean? = null, query: String, resultsPerPage: Int? = null, sort: String? = null): GetRepositoriesResult
Link copied to clipboard

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

suspend fun getRepository(description: String? = null, fullName: String? = null, homepageUrl: String? = null, name: String? = null): GetRepositoryResult
Link copied to clipboard

Use this data source to retrieve information about branches in a repository.

suspend fun getRepositoryBranches(onlyNonProtectedBranches: Boolean? = null, onlyProtectedBranches: Boolean? = null, repository: String): GetRepositoryBranchesResult
Link copied to clipboard

Use this data source to retrieve all deploy keys of a repository.

Link copied to clipboard

Use this data source to retrieve information about environments for a repository.

Link copied to clipboard

This data source allows you to read files within a GitHub repository.

suspend fun getRepositoryFile(branch: String? = null, file: String, repository: String): GetRepositoryFileResult
Link copied to clipboard

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

suspend fun getRepositoryMilestone(number: Int, owner: String, repository: String): GetRepositoryMilestoneResult
Link copied to clipboard

Use this data source to retrieve information about a specific GitHub Pull Request in a repository.

suspend fun getRepositoryPullRequest(baseRepository: String, number: Int, owner: String? = null): GetRepositoryPullRequestResult
Link copied to clipboard

Use this data source to retrieve information about multiple GitHub Pull Requests in a repository.

suspend fun getRepositoryPullRequests(baseRef: String? = null, baseRepository: String, headRef: String? = null, owner: String? = null, sortBy: String? = null, sortDirection: String? = null, state: String? = null): GetRepositoryPullRequestsInvokeResult
Link copied to clipboard

Use this data source to retrieve the list of teams which have access to a GitHub repository.

suspend fun getRepositoryTeams(fullName: String? = null, name: String? = null): GetRepositoryTeamsResult
Link copied to clipboard

Use this data source to retrieve webhooks for a given repository.

Link copied to clipboard

Use this data source to retrieve information about a GitHub resource through REST API.

suspend fun getRestApi(endpoint: String): GetRestApiResult
suspend fun getRestApi(argument: suspend GetRestApiPlainArgsBuilder.() -> Unit): GetRestApiResult
Link copied to clipboard

Use this data source to retrieve information about GitHub's SSH keys.

Link copied to clipboard
suspend fun getTeam(argument: GetTeamPlainArgs): GetTeamResult

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

suspend fun getTeam(argument: suspend GetTeamPlainArgsBuilder.() -> Unit): GetTeamResult
suspend fun getTeam(membershipType: String? = null, resultsPerPage: Int? = null, slug: String, summaryOnly: Boolean? = null): GetTeamResult
Link copied to clipboard
suspend fun getTree(argument: GetTreePlainArgs): GetTreeResult

Use this data source to retrieve information about a single tree.

suspend fun getTree(argument: suspend GetTreePlainArgsBuilder.() -> Unit): GetTreeResult
suspend fun getTree(recursive: Boolean? = null, repository: String, treeSha: String): GetTreeResult
Link copied to clipboard
suspend fun getUser(argument: GetUserPlainArgs): GetUserResult

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

suspend fun getUser(username: String): GetUserResult
suspend fun getUser(argument: suspend GetUserPlainArgsBuilder.() -> Unit): GetUserResult
Link copied to clipboard

Use this data source to retrieve a specific organization member's SAML or SCIM user attributes.

Link copied to clipboard
suspend fun getUsers(argument: GetUsersPlainArgs): GetUsersResult

Use this data source to retrieve information about multiple GitHub users at once.

suspend fun getUsers(usernames: List<String>): GetUsersResult
suspend fun getUsers(argument: suspend GetUsersPlainArgsBuilder.() -> Unit): GetUsersResult