release

package

v0.1.4 Latest Latest Go to latest Published: Mar 10, 2026 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/monkescience/yeet

Links

Open Source Insights

Documentation ¶

Overview ¶

Package release orchestrates the release process by coordinating commit parsing, version calculation, changelog generation, and VCS provider interactions.

Index ¶

Constants
Variables
type Releaser
- func New(cfg *config.Config, p provider.Provider) *Releaser
- func (r *Releaser) Release(ctx context.Context, dryRun, preview bool, previewHashLength int) (*Result, error)
- func (r *Releaser) Tag(ctx context.Context, tag, changelogBody string) (*Result, error)
type Result

Constants ¶

View Source

const (
	DefaultPreviewHashLength = 7
)

Variables ¶

View Source

var ErrChangelogEntryNotFound = errors.New("changelog entry not found")

View Source

var ErrConflictingReleaseAs = errors.New("conflicting release-as footers")

View Source

var ErrInvalidPreviewHashLength = errors.New("invalid preview hash length")

View Source

var ErrInvalidReleaseAs = errors.New("invalid release-as footer")

View Source

var ErrInvalidReleaseBranch = errors.New("invalid release branch")

View Source

var ErrMultiplePendingReleasePRs = errors.New("multiple pending release PRs found")

View Source

var ErrPreviewTagNotAllowed = errors.New("preview tags are not allowed")

Functions ¶

This section is empty.

Types ¶

type Releaser ¶

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

func New ¶

func New(cfg *config.Config, p provider.Provider) *Releaser

func (*Releaser) Release ¶

func (r *Releaser) Release(ctx context.Context, dryRun, preview bool, previewHashLength int) (*Result, error)

Release performs the full release flow: analyze commits, calculate version, generate changelog, create PR.

func (*Releaser) Tag ¶

func (r *Releaser) Tag(ctx context.Context, tag, changelogBody string) (*Result, error)

Tag creates a release tag and VCS release from a merged release PR.

type Result ¶

type Result struct {
	CurrentVersion string
	BaseVersion    string
	NextVersion    string
	BaseTag        string
	NextTag        string
	BumpType       commit.BumpType
	Changelog      string

	PullRequest *provider.PullRequest
	Release     *provider.Release
	CommitCount int
	// contains filtered or unexported fields
}

Source Files ¶

View all Source files

releaser.go

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