prpipeline

package
v1.0.2 Latest Latest
Warning

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

Go to latest
Published: Dec 14, 2025 License: MIT Imports: 14 Imported by: 0

Documentation

Overview

package prpipeline handles all actions related to PR checking

Index

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
	// Styles are the styles of PR title to enforce (can be multiple)
	Styles []PRStyle
	// Keys checks for required keys in the PR title
	Keys []string
}

type PRStyle

type PRStyle = string
const (
	JiraStyle         PRStyle = "jira"
	ConventionalStyle 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)

Jump to

Keyboard shortcuts

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