githubsource

Documentation

Overview

Package githubsource is a source driver that integrates Grit with GitHub.

It supports GitHub.com and GitHub Enterprise Server installations.

Index

• Variables
• type Config
  • func (c Config) DescribeSourceConfig() string
  • func (c Config) NewSource() sourcedriver.Source

Variables

var Registration = sourcedriver.Registration{
	Name:         "github",
	Description:  "adds support for GitHub and GitHub Enterprise Server as repository sources",
	ConfigLoader: configLoader{},
}

Registration contains information about the driver used to register it with Grit's driver registry.

Types

type Config

type Config struct {
	// Domain is the base domain name of the GitHub installation.
	Domain string

	// Token is a personal access token used to authenticate with the GitHub
	// API.
	Token string

	// Git is the configuration that controls how Grit uses Git for this source.
	Git gitvcs.Config
}

Config contains configuration specific to the GitHub driver.

func (Config) DescribeSourceConfig

func (c Config) DescribeSourceConfig() string

DescribeSourceConfig returns a human-readable description of the configuration.

func (Config) NewSource

func (c Config) NewSource() sourcedriver.Source

NewSource constructs a new source from this configuration.