config

package
v0.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 7, 2025 License: UNKNOWN not legal advice Imports: 0 Imported by: 0

Documentation

Index

Constants

View Source 
const ForceSkipDescription = "**IGNORE** the bot requirements for this PR (force green CI check)"

This is the description for a persistent rule with a non-standard behavior that allow maintainer to force the "success" state of the CI check

Variables

This section is empty.

Functions

func Config 

func Config(gh *client.GitHub) ([]AutomaticCheck, []ManualCheck)

This function returns the configuration of the bot consisting of automatic and manual checks in which the GitHub client is injected.

Types

type AutomaticCheck 

type AutomaticCheck struct {
	Description string
	If          c.Condition   // If the condition is met, the rule is displayed and the requirement is executed.
	Then        r.Requirement // If the requirement is satisfied, the check passes.
}

Automatic check that will be performed by the bot.

type ManualCheck 

type ManualCheck struct {
	Description string
	If          c.Condition // If the condition is met, a checkbox will be displayed on bot comment.
	Teams       Teams       // Members of these teams can check the checkbox to make the check pass.
}

Manual check that will be performed by users.

type Teams 

type Teams []string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL