github

package
v0.24.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 31, 2025 License: Apache-2.0 Imports: 10 Imported by: 17

Documentation

Index

Examples

Constants

View Source 
const (
	// DefaultDomain specifies the default domain used as the backend.
	DefaultDomain = "github.com"
	// TokenVariable is the common name for the environment variable
	// containing a GitHub authentication token.
	TokenVariable = "GITHUB_TOKEN" // #nosec G101
)
View Source 
const ProviderID = gitprovider.ProviderID("github")

ProviderID is the provider ID for GitHub.

Variables

This section is empty.

Functions

func NewClient 

func NewClient(optFns ...gitprovider.ClientOption) (gitprovider.Client, error)

NewClient creates a new gitprovider.Client instance for GitHub API endpoints.

Using WithOAuth2Token you can specify authentication credentials, passing no such ClientOption will allow public read access only.

Password-based authentication is not supported because it is deprecated by GitHub, see https://developer.github.com/changes/2020-02-14-deprecating-password-auth/

GitHub Enterprise can be used if you specify the domain using WithDomain.

You can customize low-level HTTP Transport functionality by using the With{Pre,Post}ChainTransportHook options. You can also use conditional requests (and an in-memory cache) using WithConditionalRequests.

The chain of transports looks like this: github.com API <-> "Post Chain" <-> Authentication <-> Cache <-> "Pre Chain" <-> *github.Client.

Types

type BranchClient added in v0.1.0 

type BranchClient struct {
	// contains filtered or unexported fields
}

BranchClient operates on the branch for a specific repository.

func (*BranchClient) Create added in v0.1.0 

func (c *BranchClient) Create(ctx context.Context, branch, sha string) error

Create creates a branch with the given specifications.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client is an interface that allows talking to a Git provider.

func (*Client) HasTokenPermission added in v0.0.3 

func (c *Client) HasTokenPermission(ctx context.Context, permission gitprovider.TokenPermission) (bool, error)

HasTokenPermission returns true if the given token has the given permissions.

func (*Client) OrgRepositories 

func (c *Client) OrgRepositories() gitprovider.OrgRepositoriesClient

OrgRepositories returns the OrgRepositoriesClient handling sets of repositories in an organization.

func (*Client) Organizations 

func (c *Client) Organizations() gitprovider.OrganizationsClient

Organizations returns the OrganizationsClient handling sets of organizations.

func (*Client) ProviderID 

func (c *Client) ProviderID() gitprovider.ProviderID

ProviderID returns the provider ID "github". This field is set at client creation time, and can't be changed.

func (*Client) Raw 

func (c *Client) Raw() interface{}

Raw returns the Go GitHub client (github.com/google/go-github/v47/github *Client) used under the hood for accessing GitHub.

func (*Client) SupportedDomain 

func (c *Client) SupportedDomain() string

SupportedDomain returns the domain endpoint for this client, e.g. "github.com", "enterprise.github.com" or "my-custom-git-server.com:6443". This allows a higher-level user to know what Client to use for what endpoints. This field is set at client creation time, and can't be changed.

func (*Client) UserRepositories 

func (c *Client) UserRepositories() gitprovider.UserRepositoriesClient

UserRepositories returns the UserRepositoriesClient handling sets of repositories for a user.

type CommitClient added in v0.1.0 

type CommitClient struct {
	// contains filtered or unexported fields
}

CommitClient operates on the commits for a specific repository.

func (*CommitClient) Create added in v0.1.0 

func (c *CommitClient) Create(ctx context.Context, branch string, message string, files []gitprovider.CommitFile) (gitprovider.Commit, error)

Create creates a commit with the given specifications.

func (*CommitClient) ListPage added in v0.1.0 

func (c *CommitClient) ListPage(ctx context.Context, branch string, perPage, page int) ([]gitprovider.Commit, error)

ListPage lists all repository commits of the given page and page size. ListPage returns all available repository commits using multiple paginated requests if needed.

type DeployKeyClient 

type DeployKeyClient struct {
	// contains filtered or unexported fields
}

DeployKeyClient operates on the access deploy key list for a specific repository.

func (*DeployKeyClient) Create 

func (c *DeployKeyClient) Create(ctx context.Context, req gitprovider.DeployKeyInfo) (gitprovider.DeployKey, error)

Create creates a deploy key with the given specifications.

ErrAlreadyExists will be returned if the resource already exists.

func (*DeployKeyClient) Get 

func (c *DeployKeyClient) Get(ctx context.Context, name string) (gitprovider.DeployKey, error)

Get returns the repository at the given path.

ErrNotFound is returned if the resource does not exist.

func (*DeployKeyClient) List 

func (c *DeployKeyClient) List(ctx context.Context) ([]gitprovider.DeployKey, error)

List lists all repository deploy keys of the given deploy key type.

List returns all available repository deploy keys for the given type, using multiple paginated requests if needed.

func (*DeployKeyClient) Reconcile 

func (c *DeployKeyClient) Reconcile(ctx context.Context, req gitprovider.DeployKeyInfo) (gitprovider.DeployKey, bool, error)

Reconcile makes sure the given desired state (req) becomes the actual state in the backing Git provider.

If req doesn't exist under the hood, it is created (actionTaken == true). If req doesn't equal the actual state, the resource will be deleted and recreated (actionTaken == true). If req is already the actual state, this is a no-op (actionTaken == false).

type FileClient added in v0.5.3 

type FileClient struct {
	// contains filtered or unexported fields
}

FileClient operates on the branch for a specific repository.

func (*FileClient) Get added in v0.5.3 

func (c *FileClient) Get(ctx context.Context, path, branch string, optFns ...gitprovider.FilesGetOption) ([]*gitprovider.CommitFile, error)

Get fetches and returns the contents of a file or multiple files in a directory from a given branch and path with possible options of FilesGetOption If a file path is given, the contents of the file are returned If a directory path is given, the contents of the files in the path's root are returned

type OrgRepositoriesClient 

type OrgRepositoriesClient struct {
	// contains filtered or unexported fields
}

OrgRepositoriesClient operates on repositories the user has access to.

func (*OrgRepositoriesClient) Create 

func (c *OrgRepositoriesClient) Create(ctx context.Context, ref gitprovider.OrgRepositoryRef, req gitprovider.RepositoryInfo, opts ...gitprovider.RepositoryCreateOption) (gitprovider.OrgRepository, error)

Create creates a repository for the given organization, with the data and options.

ErrAlreadyExists will be returned if the resource already exists.

func (*OrgRepositoriesClient) Get 

func (c *OrgRepositoriesClient) Get(ctx context.Context, ref gitprovider.OrgRepositoryRef) (gitprovider.OrgRepository, error)

Get returns the repository at the given path.

ErrNotFound is returned if the resource does not exist.

Example 
// Create a new client
ctx := context.Background()
c, err := github.NewClient()
checkErr(err)

// Parse the URL into an OrgRepositoryRef
ref, err := gitprovider.ParseOrgRepositoryURL("https://github.com/fluxcd/flux2")
checkErr(err)

// Get public information about the flux repository.
repo, err := c.OrgRepositories().Get(ctx, *ref)
checkErr(err)

// Use .Get() to aquire a high-level gitprovider.OrganizationInfo struct
repoInfo := repo.Get()
// Cast the internal object to a *gogithub.Repository to access custom data
internalRepo := repo.APIObject().(*gogithub.Repository)

fmt.Printf("Description: %s. Homepage: %s", *repoInfo.Description, internalRepo.GetHomepage())

Output:

Description: Open and extensible continuous delivery solution for Kubernetes. Powered by GitOps Toolkit.. Homepage: https://fluxcd.io

func (*OrgRepositoriesClient) List 

func (c *OrgRepositoriesClient) List(ctx context.Context, ref gitprovider.OrganizationRef) ([]gitprovider.OrgRepository, error)

List all repositories in the given organization.

List returns all available repositories, using multiple paginated requests if needed.

func (*OrgRepositoriesClient) Reconcile 

func (c *OrgRepositoriesClient) Reconcile(ctx context.Context, ref gitprovider.OrgRepositoryRef, req gitprovider.RepositoryInfo, opts ...gitprovider.RepositoryReconcileOption) (gitprovider.OrgRepository, bool, error)

Reconcile makes sure the given desired state (req) becomes the actual state in the backing Git provider.

If req doesn't exist under the hood, it is created (actionTaken == true). If req doesn't equal the actual state, the resource will be updated (actionTaken == true). If req is already the actual state, this is a no-op (actionTaken == false).

type OrganizationsClient 

type OrganizationsClient struct {
	// contains filtered or unexported fields
}

OrganizationsClient operates on organizations the user has access to.

func (*OrganizationsClient) Children 

func (c *OrganizationsClient) Children(_ context.Context, _ gitprovider.OrganizationRef) ([]gitprovider.Organization, error)

Children returns the immediate child-organizations for the specific OrganizationRef o. The OrganizationRef may point to any existing sub-organization.

This is not supported in GitHub.

Children returns all available organizations, using multiple paginated requests if needed.

func (*OrganizationsClient) Get 

func (c *OrganizationsClient) Get(ctx context.Context, ref gitprovider.OrganizationRef) (gitprovider.Organization, error)

Get a specific organization the user has access to. This can't refer to a sub-organization in GitHub, as those aren't supported.

ErrNotFound is returned if the resource does not exist.

Example 
package main

import (
	"context"
	"fmt"
	"log"

	"github.com/fluxcd/go-git-providers/github"
	"github.com/fluxcd/go-git-providers/gitprovider"
	gogithub "github.com/google/go-github/v72/github"
)

// checkErr is used for examples in this repository.
func checkErr(err error) {
	if err != nil {
		log.Fatal(err)
	}
}

func main() {
	// Create a new client
	ctx := context.Background()
	c, err := github.NewClient()
	checkErr(err)

	// Get public information about the fluxcd organization
	org, err := c.Organizations().Get(ctx, gitprovider.OrganizationRef{
		Domain:       github.DefaultDomain,
		Organization: "fluxcd",
	})
	checkErr(err)

	// Use .Get() to aquire a high-level gitprovider.OrganizationInfo struct
	orgInfo := org.Get()
	// Cast the internal object to a *gogithub.Organization to access custom data
	internalOrg := org.APIObject().(*gogithub.Organization)

	fmt.Printf("Name: %s. Description: %s.", *orgInfo.Name, internalOrg.GetDescription())
}

Output:

Name: Flux project. Description: Open and extensible continuous delivery solution for Kubernetes.

func (*OrganizationsClient) List 

func (c *OrganizationsClient) List(ctx context.Context) ([]gitprovider.Organization, error)

List all top-level organizations the specific user has access to.

List returns all available organizations, using multiple paginated requests if needed.

type PullRequestClient added in v0.1.0 

type PullRequestClient struct {
	// contains filtered or unexported fields
}

PullRequestClient operates on the pull requests for a specific repository.

func (*PullRequestClient) Create added in v0.1.0 

func (c *PullRequestClient) Create(ctx context.Context, title, branch, baseBranch, description string) (gitprovider.PullRequest, error)

Create creates a pull request with the given specifications.

func (*PullRequestClient) Edit added in v0.10.0 

func (c *PullRequestClient) Edit(ctx context.Context, number int, opts gitprovider.EditOptions) (gitprovider.PullRequest, error)

Edit modifies an existing PR. Please refer to "EditOptions" for details on which data can be edited.

func (*PullRequestClient) Get added in v0.3.0 

func (c *PullRequestClient) Get(ctx context.Context, number int) (gitprovider.PullRequest, error)

Get retrieves an existing pull request by number

func (*PullRequestClient) List added in v0.3.0 

func (c *PullRequestClient) List(ctx context.Context) ([]gitprovider.PullRequest, error)

List lists all pull requests in the repository

func (*PullRequestClient) Merge added in v0.3.0 

func (c *PullRequestClient) Merge(ctx context.Context, number int, mergeMethod gitprovider.MergeMethod, message string) error

Merge merges a pull request with the given specifications.

type TeamAccessClient 

type TeamAccessClient struct {
	// contains filtered or unexported fields
}

TeamAccessClient operates on the teams list for a specific repository.

func (*TeamAccessClient) Create 

func (c *TeamAccessClient) Create(ctx context.Context, req gitprovider.TeamAccessInfo) (gitprovider.TeamAccess, error)

Create adds a given team to the repo's team access control list.

ErrAlreadyExists will be returned if the resource already exists.

func (*TeamAccessClient) Get 

func (c *TeamAccessClient) Get(ctx context.Context, name string) (gitprovider.TeamAccess, error)

Get a team within the specific organization.

name may include slashes, but must not be an empty string. Teams are sub-groups in GitLab.

ErrNotFound is returned if the resource does not exist.

TeamAccess.APIObject will be nil, because there's no underlying Github struct.

func (*TeamAccessClient) List 

func (c *TeamAccessClient) List(ctx context.Context) ([]gitprovider.TeamAccess, error)

List lists the team access control list for this repository.

List returns all available team access lists, using multiple paginated requests if needed.

func (*TeamAccessClient) Reconcile 

func (c *TeamAccessClient) Reconcile(ctx context.Context,
	req gitprovider.TeamAccessInfo,
) (gitprovider.TeamAccess, bool, error)

Reconcile makes sure the given desired state (req) becomes the actual state in the backing Git provider.

If req doesn't exist under the hood, it is created (actionTaken == true). If req doesn't equal the actual state, the resource will be deleted and recreated (actionTaken == true). If req is already the actual state, this is a no-op (actionTaken == false).

type TeamsClient 

type TeamsClient struct {
	// contains filtered or unexported fields
}

TeamsClient handles teams organization-wide.

func (*TeamsClient) Get 

func (c *TeamsClient) Get(ctx context.Context, teamName string) (gitprovider.Team, error)

Get a team within the specific organization.

teamName may include slashes, to point to e.g. subgroups in GitLab. teamName must not be an empty string.

ErrNotFound is returned if the resource does not exist.

func (*TeamsClient) List 

func (c *TeamsClient) List(ctx context.Context) ([]gitprovider.Team, error)

List all teams (recursively, in terms of subgroups) within the specific organization.

List returns all available organizations, using multiple paginated requests if needed.

type TreeClient added in v0.9.0 

type TreeClient struct {
	// contains filtered or unexported fields
}

TreeClient operates on the trees in a specific repository.

func (*TreeClient) Get added in v0.9.0 

func (c *TreeClient) Get(ctx context.Context, sha string, recursive bool) (*gitprovider.TreeInfo, error)

Get returns a single tree using the SHA1 value for that tree. uses https://docs.github.com/en/rest/git/trees#get-a-tree

func (*TreeClient) List added in v0.9.0 

func (c *TreeClient) List(ctx context.Context, sha string, path string, recursive bool) ([]*gitprovider.TreeEntry, error)

List files (blob) in a tree givent the tree sha (path is not used with Github Tree client)

type UserRepositoriesClient 

type UserRepositoriesClient struct {
	// contains filtered or unexported fields
}

UserRepositoriesClient operates on repositories the user has access to.

func (*UserRepositoriesClient) Create 

func (c *UserRepositoriesClient) Create(ctx context.Context,
	ref gitprovider.UserRepositoryRef,
	req gitprovider.RepositoryInfo,
	opts ...gitprovider.RepositoryCreateOption,
) (gitprovider.UserRepository, error)

Create creates a repository for the given organization, with the data and options

ErrAlreadyExists will be returned if the resource already exists.

func (*UserRepositoriesClient) Get 

func (c *UserRepositoriesClient) Get(ctx context.Context, ref gitprovider.UserRepositoryRef) (gitprovider.UserRepository, error)

Get returns the repository at the given path.

ErrNotFound is returned if the resource does not exist.

func (*UserRepositoriesClient) GetUserLogin added in v0.19.0 

func (c *UserRepositoriesClient) GetUserLogin(ctx context.Context) (gitprovider.IdentityRef, error)

GetUserLogin returns the current authenticated user.

func (*UserRepositoriesClient) List 

func (c *UserRepositoriesClient) List(ctx context.Context, ref gitprovider.UserRef) ([]gitprovider.UserRepository, error)

List all repositories in the given organization.

List returns all available repositories, using multiple paginated requests if needed.

func (*UserRepositoriesClient) Reconcile 

func (c *UserRepositoriesClient) Reconcile(ctx context.Context, ref gitprovider.UserRepositoryRef, req gitprovider.RepositoryInfo, opts ...gitprovider.RepositoryReconcileOption) (gitprovider.UserRepository, bool, error)

Reconcile makes sure the given desired state (req) becomes the actual state in the backing Git provider.

If req doesn't exist under the hood, it is created (actionTaken == true). If req doesn't equal the actual state, the resource will be updated (actionTaken == true). If req is already the actual state, this is a no-op (actionTaken == false).

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.