github

package

v0.19.0 Latest Latest Go to latest Published: Sep 17, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Details

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

Repository

github.com/giantswarm/marge

Links

Open Source Insights

Documentation ¶

Overview ¶

Package github creates the authenticated GitHub API client marge uses.

Index ¶

func AuthenticatedLogin(ctx context.Context, client *github.Client) (string, error)
func LoadToken(ctx context.Context) string
func NewAppClient(app *App, baseURL string, httpClient *http.Client) (*github.Client, error)
func NewClient(ctx context.Context) (*github.Client, error)
type App
- func LoadApp() (*App, error)
- func (a *App) JWT(now time.Time) (string, error)
- func (a *App) MintToken(ctx context.Context, httpClient *http.Client, baseURL string, repos []string) (string, time.Time, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AuthenticatedLogin ¶ added in v0.19.0

func AuthenticatedLogin(ctx context.Context, client *github.Client) (string, error)

AuthenticatedLogin returns the login the client acts as. An installation token has no user behind it, so GET /user answers 403 and the App's own slug names the bot instead.

func LoadToken ¶

func LoadToken(ctx context.Context) string

LoadToken returns the GitHub token from GITHUB_TOKEN, GH_TOKEN or, failing both, the GitHub CLI's own login (`gh auth token`). It returns "" when none of them yields a token.

func NewAppClient ¶ added in v0.19.0

func NewAppClient(app *App, baseURL string, httpClient *http.Client) (*github.Client, error)

NewAppClient returns a client that authenticates as the App against baseURL. A nil httpClient uses the default transport. Only the tests pass either argument; NewClient supplies GitHub's own.

func NewClient ¶

func NewClient(ctx context.Context) (*github.Client, error)

NewClient returns a GitHub API client. It authenticates as the sweep App when the environment carries the App credential, and with the token LoadToken finds otherwise.

Types ¶

type App ¶ added in v0.19.0

type App struct {
	ID             int64
	InstallationID int64
	// contains filtered or unexported fields
}

App is the sweep GitHub App's credential. It mints installation tokens on demand and holds no token beyond the life of the process.

func LoadApp ¶ added in v0.19.0

func LoadApp() (*App, error)

LoadApp returns the App credential the environment carries, or nil when it carries none, which is not an error: the token path serves a person running the CLI. A partial credential is an error, because it is a misconfigured unattended run and not a person's shell.

func (*App) JWT ¶ added in v0.19.0

func (a *App) JWT(now time.Time) (string, error)

JWT returns the App JWT that authenticates marge as the App itself, which is what the token mint and GET /app accept.

func (*App) MintToken ¶ added in v0.19.0

func (a *App) MintToken(ctx context.Context, httpClient *http.Client, baseURL string, repos []string) (string, time.Time, error)

MintToken returns an installation token for the named repositories. GitHub scopes the token to those repositories alone: every other repository of the installation answers 404 under it.

Source Files ¶

View all Source files

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