inst

package

v0.0.0-...-da9c117 Latest Latest Go to latest Published: May 1, 2024 License: BSD-3-Clause Imports: 7 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package inst implements GitHub App Installation authentication.

This section is empty.

This section is empty.

This section is empty.

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

Config defines an GitHub app installation config.

func NewConfig(appID, instID string, key *rsa.PrivateKey) (*Config, error)

NewConfig returns a new GitHub App instance.

func NewEnterpriseConfig(url, appID, instID string, key *rsa.PrivateKey) (*Config, error)

NewEnterpriseConfig returns a new GitHub App instance.

func (c *Config) Client(ctx context.Context) *http.Client

Client returns an HTTP client wrapping the context's HTTP transport and adding Authorization headers with tokens obtained using JWT.

The returned client and its Transport should not be modified.

func (c *Config) Permissions() (map[string]string, error)

Permissions returns a map of the GitHub app client's permissions.

func (c *Config) RepositorySelection() (string, error)

RepositorySelection returns the GitHub app client's repository selection (all or selected).

func (c *Config) SetRepositories(names []string)

SetRepositories returns an updated installation with the provided repositories. Access will be limited to the list of provided repositories

func (c *Config) SetRepositoryIDs(ids []string)

SetRepositoryIDs returns an updated installation with the provided repository ids. Access will be limited to the list of provided repository IDs.