Documentation
¶
Index ¶
- Variables
- func CheckSignature(installationID int64) error
- func DivideScope(scope string) (string, string)
- func ExistGitHubRepository(scope, gheDomain string, githubPersonalToken string) error
- func ExistGitHubRunner(ctx context.Context, client *github.Client, owner, repo, runnerName string) (*github.Runner, error)
- func GenerateGitHubAppsToken(ctx context.Context, clientApps *github.Client, installationID int64) (string, *time.Time, error)
- func GenerateRunnerRegistrationToken(ctx context.Context, gheDomain string, installationID int64, scope string) (string, *time.Time, error)
- func IsInstalledGitHubApp(ctx context.Context, gheDomain, inputScope string) (int64, error)
- func ListRunners(ctx context.Context, client *github.Client, owner, repo string) ([]*github.Runner, error)
- func NewClient(ctx context.Context, personalToken, gheDomain string) (*github.Client, error)
- func NewClientGitHubApps(gheDomain string, appID int64, appPEM []byte) (*github.Client, error)
- func NewClientInstallation(gheDomain string, installationID int64, appID int64, appPEM []byte) (*github.Client, error)
- type Scope
Constants ¶
This section is empty.
Variables ¶
var ( GHlistInstallations = listInstallations GHlistAppsInstalledRepo = listAppsInstalledRepo GHNewClientGitHubApps = NewClientGitHubApps )
function pointers (for testing)
var ( // ErrNotFound is error for not found ErrNotFound = fmt.Errorf("not found") )
Functions ¶
func CheckSignature ¶
CheckSignature check trust installation id from event.
func DivideScope ¶ added in v1.6.1
DivideScope divide scope to owner and repo
func ExistGitHubRepository ¶
ExistGitHubRepository check exist of GitHub repository
func ExistGitHubRunner ¶ added in v1.9.2
func ExistGitHubRunner(ctx context.Context, client *github.Client, owner, repo, runnerName string) (*github.Runner, error)
ExistGitHubRunner check exist registered of GitHub runner
func GenerateGitHubAppsToken ¶ added in v1.7.0
func GenerateGitHubAppsToken(ctx context.Context, clientApps *github.Client, installationID int64) (string, *time.Time, error)
GenerateGitHubAppsToken generate token of GitHub Apps using private key clientApps needs to response of `NewClientGitHubApps()`
func GenerateRunnerRegistrationToken ¶ added in v1.9.11
func GenerateRunnerRegistrationToken(ctx context.Context, gheDomain string, installationID int64, scope string) (string, *time.Time, error)
GenerateRunnerRegistrationToken generate token for register runner
func IsInstalledGitHubApp ¶ added in v1.7.0
IsInstalledGitHubApp check installed GitHub Apps in gheDomain + inputScope
func ListRunners ¶ added in v1.6.1
func ListRunners(ctx context.Context, client *github.Client, owner, repo string) ([]*github.Runner, error)
ListRunners get runners that registered repository or org
func NewClientGitHubApps ¶ added in v1.9.7
NewClientGitHubApps create a client of GitHub using Private Key from GitHub Apps header is "Authorization: Bearer YOUR_JWT" docs: https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-a-github-app
func NewClientInstallation ¶ added in v1.9.7
func NewClientInstallation(gheDomain string, installationID int64, appID int64, appPEM []byte) (*github.Client, error)
NewClientInstallation create a client of GitHub using installation ID from GitHub Apps header is "Authorization: token YOUR_INSTALLATION_ACCESS_TOKEN" docs: https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-an-installation
Source Files