auto

Documentation

Overview

Package auto contains functions and types related to automation in response to repository events. In practice, this is the GitHub integration.

Testground scheduling should be configured by a rulebook that defines what test plans or test cases are launched when, e.g. on new commits to `master` of repo go-ipfs, launch X test plans; on commits on branches of any repo in the libp2p org, launch X test plan; etc.

This rulebook should be specified in a TOML configuration file, passed to the testground daemon, e.g.:

testground daemon --config testground.toml

This package is also responsible for reacting to GitHub comments from befriended developers, e.g.

@testbot run <testplan> with <dependency=gitref> <dependency=gitref> <dependency=gitref>

As well as maintaining that developer whitelist.

Index

• type RepoCommand
• type TriggerSource

Types

type RepoCommand

type RepoCommand struct {
	Timestamp time.Time
	// Source is an enum indicating the method by which this run was triggered.
	Source TriggerSource
	// User carries the username that triggered this run.
	User string
	// RepoURL carries the URL of the upstream repo subject of test.
	RepoURL string
	// CommitSHA indicates the commit hash to be subjected to testing.
	CommitSHA string
	// Release carries the release name, if this run was triggered by a release.
	Release string
	// Branch carries the branch name, if this run was triggered by a commit or a mention.
	Branch string
	// PullRequestURL carries the URL of the pull request, if this release was triggered by a mention.
	PullRequestURL string
}

type TriggerSource

type TriggerSource int

const (
	TriggerSourceManual TriggerSource = iota
	TriggerSourceGithubMention
	TriggerSourceGithubCommit
	TriggerSourceGithubRelease
)