bootstrap

Documentation

Overview

Package bootstrap is used by the bootstrap command as a quick-start of Atlantis.

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. Forks can take up to 5 minutes to complete according to GitHub.

func (*Client) CreateFork

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

CreateFork forks a GitHub repo into the user's account 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. If there's already a pull request open for this branch it will return successfully.

func (*Client) CreateWebhook

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

CreateWebhook creates a GitHub webhook to send requests to our local ngrok.