github

package

v0.27.0 Latest Latest Go to latest Published: Apr 28, 2025 License: Apache-2.0 Imports: 11 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/fluxcd/pkg

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type AppToken
- func (at *AppToken) GetDuration() time.Duration
type Client
- func New(opts ...OptFunc) (*Client, error)
- func (p *Client) GetToken(ctx context.Context) (*AppToken, error)
type OptFunc

Constants ¶

View Source

const (
	AppIDKey             = "githubAppID"
	AppInstallationIDKey = "githubAppInstallationID"
	AppPrivateKey        = "githubAppPrivateKey"
	AppBaseUrlKey        = "githubAppBaseURL"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AppToken ¶

type AppToken struct {
	Token     string    `json:"token"`
	ExpiresAt time.Time `json:"expires_at"`
}

AppToken contains a GitHub App installation token and its expiry.

func (*AppToken) GetDuration ¶

func (at *AppToken) GetDuration() time.Duration

GetDuration returns the duration until the token expires.

type Client ¶

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

Client is an authentication provider for GitHub Apps.

func New ¶

func New(opts ...OptFunc) (*Client, error)

New returns a new authentication provider for GitHub Apps.

func (*Client) GetToken ¶

func (p *Client) GetToken(ctx context.Context) (*AppToken, error)

GetToken returns the token that can be used to authenticate as a GitHub App installation. Ref: https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation

type OptFunc ¶

type OptFunc func(*Client)

OptFunc enables specifying options for the provider.

func WithAppBaseURL ¶

func WithAppBaseURL(appBaseURL string) OptFunc

WithAppBaseURL configures the GitHub API endpoint to use to fetch GitHub App installation token.

func WithAppData ¶

func WithAppData(appData map[string][]byte) OptFunc

WithAppData configures the client using data from a map

func WithAppID ¶

func WithAppID(appID string) OptFunc

WithAppID configures the app ID of the GitHub App.

func WithCache ¶

func WithCache(cache *cache.TokenCache, kind, name, namespace string) OptFunc

WithCache sets the token cache and the object involved in the operation for recording cache events.

func WithInstllationID ¶

func WithInstllationID(installationID string) OptFunc

WithInstallationID configures the installation ID of the GitHub App.

func WithPrivateKey ¶

func WithPrivateKey(pk []byte) OptFunc

WithPrivateKey configures the private key of the GitHub App.

func WithProxyURL ¶

func WithProxyURL(proxyURL *url.URL) OptFunc

WithProxyURL sets the proxy URL to use with the transport.

Source Files ¶

View all Source files

client.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL