bootstrap

Documentation

Overview

Package bootstrap is used to make getting started with atlantis easier

Index

• func Start() error
• type Client
  • func (g *Client) CheckForkSuccess(ownerName string, forkRepoName string) bool
  • func (g *Client) CreateFork(owner string, repoName string) error
  • func (g *Client) CreatePullRequest(ownerName string, repoName string, head string, base string) (string, error)
  • func (g *Client) CreateWebhook(ownerName string, repoName string, hookURL string) error

Functions

func Start

func Start() error

Start begins the bootstrap process nolint: errcheck

Types

type Client

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

Client used for github interactions

func (*Client) CheckForkSuccess

func (g *Client) CheckForkSuccess(ownerName string, forkRepoName string) bool

CheckForkSuccess waits for github fork to complete

func (*Client) CreateFork

func (g *Client) CreateFork(owner string, repoName string) error

CreateFork forks a github repo into user that is authenticated

func (*Client) CreatePullRequest

func (g *Client) CreatePullRequest(ownerName string, repoName string, head string, base string) (string, error)

CreatePullRequest creates a github pull request with custom title and description. It first checks if there's already a pull request open for this branch

func (*Client) CreateWebhook

func (g *Client) CreateWebhook(ownerName string, repoName string, hookURL string) error

CreateWebhook creates a github webhook