github

package

v0.17.0-rc.1 Latest Latest Go to latest Published: Nov 9, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Details

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

Repository

github.com/rancher/fleet

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func GetGithubAppAuthFromSecret(repo string, creds *corev1.Secret, getter AppAuthGetter, tlsCfg netx.TLSConfig) (*httpgit.BasicAuth, error)
func HasGitHubAppKeys(secret *corev1.Secret) bool
type AppAuthGetter
type DefaultAppAuthGetter
- func (DefaultAppAuthGetter) Get(repo string, appID, insID int64, pem []byte, tlsCfg netx.TLSConfig) (*httpgit.BasicAuth, error)
type GitHubApp
- func NewApp(repo string, appID, installID int64, pem []byte) *GitHubApp
- func (app *GitHubApp) GetToken(ctx context.Context, tlsCfg netx.TLSConfig) (string, error)

Constants ¶

View Source

const (
	GitHubAppAuthInstallationIDKey = "github_app_installation_id"
	GitHubAppAuthIDKey             = "github_app_id"
	GitHubAppAuthPrivateKeyKey     = "github_app_private_key"
)

View Source

const (
	GithubAppIDKey             = "github_app_id"
	GithubAppInstallationIDKey = "github_app_installation_id"
	GithubAppPrivateKeyKey     = "github_app_private_key"
)

Variables ¶

View Source

var ErrNotGithubAppSecret = errors.New("not a GitHub App secret")

Functions ¶

func GetGithubAppAuthFromSecret ¶

func GetGithubAppAuthFromSecret(repo string, creds *corev1.Secret, getter AppAuthGetter, tlsCfg netx.TLSConfig) (*httpgit.BasicAuth, error)

func HasGitHubAppKeys ¶

func HasGitHubAppKeys(secret *corev1.Secret) bool

HasGitHubAppKeys checks if the provided Kubernetes secret contains the necessary keys for a GitHub App: app ID, installation ID, and private key.

Types ¶

type AppAuthGetter ¶

type AppAuthGetter interface {
	Get(repo string, appID, insID int64, pem []byte, tlsCfg netx.TLSConfig) (*httpgit.BasicAuth, error)
}

type DefaultAppAuthGetter ¶

type DefaultAppAuthGetter struct{}

func (DefaultAppAuthGetter) Get ¶

func (DefaultAppAuthGetter) Get(repo string, appID, insID int64, pem []byte, tlsCfg netx.TLSConfig) (*httpgit.BasicAuth, error)

type GitHubApp ¶

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

func NewApp ¶

func NewApp(repo string, appID, installID int64, pem []byte) *GitHubApp

NewApp creates a new GitHubApp instance with the provided app ID, installation ID, and private key, and returns a pointer to it.

func (*GitHubApp) GetToken ¶

func (app *GitHubApp) GetToken(ctx context.Context, tlsCfg netx.TLSConfig) (string, error)

GetToken retrieves a GitHub App installation token using the provided app ID, installation ID, and private key (PEM format). It returns the token as a string or an error if the process fails.

Source Files ¶

View all Source files

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