Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Configuration ¶ added in v0.11.0
type Configuration struct {
Token string
Draft bool
Label string
Strict bool
Close bool
TitlePattern string
CommitPattern string
BranchPattern string
Message string
FileChanges int
Issue bool
Body bool
Bot bool
Signed bool
Verbose bool
Edit bool
IgnoredUsers []string
RestURL string
GraphQLURL string
}
Configuration is a configuration object that is parsed from the action input
func ReadConfig ¶
func ReadConfig() (*Configuration, error)
ReadConfig reads environment variables for input values which are supplied from an action runner and create Conventional PR's configuration from it
type Event ¶
type Event struct {
// action name
Action string `json:"action"`
// pull request number
Number int `json:"number"`
}
Event that triggers the action
type IssueReference ¶ added in v0.15.0
type Meta ¶
Meta is a struct that represents repository's metadata
func CreateMeta ¶
CreateMeta from a GitHub's repository string
type PullRequest ¶ added in v0.15.0
type PullRequestResult ¶ added in v0.11.0
type PullRequestResult struct {
Validation []*ValidationResult
Whitelist []*WhitelistResult
}
PullRequestResult is intermediary type to combine validation and whitelist results
type ValidationResult ¶
ValidationResult represents validator checking result on a pull request
type WhitelistResult ¶
WhitelistResult represents whitelist checking result on a pull request
Click to show internal directories.
Click to hide internal directories.