prpipeline

package

v0.20.2 Latest Latest Go to latest Published: Jun 21, 2023 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aevea/commitsar

Links

Open Source Insights

Documentation ¶

Overview ¶

package prpipeline handles all actions related to PR checking

Index ¶

type Options
type PRStyle
type Pipeline
- func New(options Options) (*Pipeline, error)
- func (pipeline *Pipeline) Name() string
- func (pipeline *Pipeline) Run() (*dispatcher.PipelineSuccess, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Options ¶

type Options struct {
	// Path to the git repository
	Path string
	// Style is the style of PR title to enforce
	Style PRStyle
	// Keys checks for required keys in the PR title
	Keys []string
}

type PRStyle ¶

type PRStyle = string

const (
	JiraStyle        PRStyle = "jira"
	ConvetionalStyle PRStyle = "conventional"
)

type Pipeline ¶

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

Pip

func New ¶

func New(options Options) (*Pipeline, error)

func (*Pipeline) Name ¶

func (pipeline *Pipeline) Name() string

func (*Pipeline) Run ¶

func (pipeline *Pipeline) Run() (*dispatcher.PipelineSuccess, error)

Source Files ¶

View all Source files

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