options

package
v0.6.2 Latest Latest
Warning

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

Go to latest
Published: Aug 6, 2025 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CommitOptions

type CommitOptions struct {
	Name    string
	Email   string
	Message string
	UseGit  *bool
	Sign    *bool
}

func (*CommitOptions) Validate

func (co *CommitOptions) Validate() error

Validate checks the consistency of the commit options

type PullRequestFileListOptions

type PullRequestFileListOptions struct {
	Title         string
	Body          string
	BaseBranch    string
	CommitOptions CommitOptions
}

PullRequestFileList

type PullRequestManagerOptions

type PullRequestManagerOptions struct {
	// UseGit controls if commits are done using the git binary. If false,
	// commits are done using a pure Go implementation. This methodd, however,
	// does not support signing. To sign commits, set this to true, and
	// commits will be done using `git commit -Ssm "Message"`, using the
	// local configuration.
	//
	// If the pointer is nil, the clone will look for the git binary and use
	// it if found or revert to pure go if not found.
	//
	// Note that the git binary can only be used when the repo is cloned to
	// disk and will error if attempting to commit a memory clone.
	UseGitToCommit *bool

	// Perform all ops on the repo clone in memory
	CloneToMemory bool

	// UseFork will force the pr manager to user a fork in the user's org
	UseFork bool

	// ForkName is an optional name to use when looking for the repo fork
	ForkName string

	// RemoteName is the name of the git remote that will be configured in
	// the repository clones
	RemoteName string
}

PullRequestManagerOptions captures the pr manager options

func (*PullRequestManagerOptions) Validate

func (prmo *PullRequestManagerOptions) Validate() error

Validate checks the consistency of the pr manager options

type PullRequestOptions

type PullRequestOptions struct {
	Title string
	Body  string
	Head  string
	Base  string // main
}

PullRequestOptions control how the manager opens a pull request on GitHub

Jump to

Keyboard shortcuts

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