github

Documentation

Overview

Package github provides the ability for Vela to integrate with GitHub or GitHub Enterprise as a scm provider.

Usage:

import "github.com/go-vela/server/scm/github"

Index

• func New(opts ...ClientOpt) (*client, error)
• func NewTest(urls ...string) (*client, error)
• type ClientOpt
  • func WithAddress(address string) ClientOpt
  • func WithClientID(id string) ClientOpt
  • func WithClientSecret(secret string) ClientOpt
  • func WithScopes(scopes []string) ClientOpt
  • func WithServerAddress(address string) ClientOpt
  • func WithServerWebhookAddress(address string) ClientOpt
  • func WithStatusContext(context string) ClientOpt
  • func WithWebUIAddress(address string) ClientOpt

Functions

func New

func New(opts ...ClientOpt) (*client, error)

New returns a SCM implementation that integrates with a GitHub or a GitHub Enterprise instance.

nolint: revive // ignore returning unexported client

func NewTest

func NewTest(urls ...string) (*client, error)

NewTest returns a SCM implementation that integrates with the provided mock server. Only the url from the mock server is required.

This function is intended for running tests only.

nolint: revive // ignore returning unexported client

Types

type ClientOpt

type ClientOpt func(*client) error

ClientOpt represents a configuration option to initialize the scm client for GitHub.

func WithAddress

func WithAddress(address string) ClientOpt

WithAddress sets the GitHub address in the scm client for GitHub.

func WithClientID

func WithClientID(id string) ClientOpt

WithClientID sets the OAuth client ID in the scm client for GitHub.

func WithClientSecret

func WithClientSecret(secret string) ClientOpt

WithClientSecret sets the OAuth client secret in the scm client for GitHub.

func WithScopes

func WithScopes(scopes []string) ClientOpt

WithScopes sets the OAuth scopes in the scm client for GitHub.

func WithServerAddress

func WithServerAddress(address string) ClientOpt

WithServerAddress sets the Vela server address in the scm client for GitHub.

func WithServerWebhookAddress

func WithServerWebhookAddress(address string) ClientOpt

WithServerWebhookAddress sets the Vela server webhook address in the scm client for GitHub.

func WithStatusContext

func WithStatusContext(context string) ClientOpt

WithStatusContext sets the context for commit statuses in the scm client for GitHub.

func WithWebUIAddress

func WithWebUIAddress(address string) ClientOpt

WithWebUIAddress sets the Vela web UI address in the scm client for GitHub.