github

package

v0.0.0-...-8c1d2e9 Latest Latest Go to latest Published: Oct 30, 2026 License: AGPL-3.0 Imports: 9 Imported by: 0

Details

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

Repository

github.com/zeitlos/lucity

Links

Open Source Insights

Documentation ¶

Index ¶

type App
- func NewApp(appID int64, clientID, clientSecret, privateKeyPath string) (*App, error)
type Commit
type Installation

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type App ¶

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

func NewApp ¶

func NewApp(appID int64, clientID, clientSecret, privateKeyPath string) (*App, error)

NewApp creates a new GitHub App client. privateKeyPath is the path to the GitHub App's PEM private key file.

func (*App) Branches ¶

func (a *App) Branches(ctx context.Context, installationID int64, repository string) ([]string, error)

func (*App) Commit ¶

func (a *App) Commit(ctx context.Context, installationID int64, repository, ref string) (Commit, error)

func (*App) FindInstallation ¶

func (a *App) FindInstallation(ctx context.Context, repository string) (int64, error)

FindInstallation returns the installation ID of the GitHub App for the given repository. repository must be in "owner/repo" form. Uses app-level JWT auth (private key required).

func (*App) Installation ¶

func (a *App) Installation(ctx context.Context, installationID int64) (*Installation, error)

Installation fetches a single GitHub App installation by ID.

func (*App) InstallationID ¶

func (a *App) InstallationID(ctx context.Context, userToken *oauth2.Token) (int64, error)

InstallationID discovers the GitHub App installation ID for the authenticated user. Uses the user's OAuth token to query their installations and returns the one matching this App's ID.

func (*App) InstallationToken ¶

func (a *App) InstallationToken(ctx context.Context, installationID int64) (string, error)

func (*App) InstallationTokenForRepo ¶

func (a *App) InstallationTokenForRepo(ctx context.Context, installationID int64, repository string) (string, error)

func (*App) Installations ¶

func (a *App) Installations(ctx context.Context) ([]Installation, error)

Installations lists all installations of this GitHub App. Uses the App's private key to authenticate as the app itself (JWT).

func (*App) UserInstallations ¶

func (a *App) UserInstallations(ctx context.Context, userToken *oauth2.Token) ([]Installation, error)

UserInstallations returns all GitHub App installations accessible to the user. Uses the user's OAuth token to query their installations.

type Commit ¶

type Commit struct {
	SHA     string
	Message string
}

type Installation ¶

type Installation struct {
	ID            int64
	AccountLogin  string
	AccountAvatar string
	AccountType   string // "Organization" or "User"
}

Installation represents a GitHub App installation on an account.

Source Files ¶

View all Source files

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