release

package

v0.4.6 Latest Latest Go to latest Published: Mar 27, 2026 License: MIT Imports: 15 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 ¶

Variables
type Releaser
- func New(cfg *config.Config, deps releaserDependencies) (*Releaser, error)
type Result
type TargetPlan

Constants ¶

This section is empty.

Variables ¶

View Source

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

View Source

var ErrConflictingFileUpdate = errors.New("conflicting file update")

View Source

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

View Source

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

View Source

var ErrInvalidReleaseManifest = errors.New("invalid release manifest")

View Source

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

View Source

var ErrUnknownTarget = errors.New("unknown target")

Functions ¶

This section is empty.

Types ¶

type Releaser ¶

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

func New ¶

func New(cfg *config.Config, deps releaserDependencies) (*Releaser, error)

func (*Releaser) Release ¶

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

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

func (*Releaser) ReleaseTargets ¶ added in v0.4.0

func (r *Releaser) ReleaseTargets(ctx context.Context, dryRun bool, selectedTargetIDs []string) (*Result, error)

ReleaseTargets performs the release flow for all or selected targets.

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 {
	BaseBranch  string
	Plans       []TargetPlan
	PullRequest *provider.PullRequest
	Releases    []*provider.Release
}

type TargetPlan ¶ added in v0.4.0

type TargetPlan struct {
	ID              string
	Type            string
	Path            string
	CurrentVersion  string
	NextVersion     string
	NextTag         string
	BumpType        commit.BumpType
	CommitCount     int
	Changelog       string
	PRChangelog     string
	PRCompareRef    string
	Files           map[string]string
	IncludedTargets []string
	// contains filtered or unexported fields
}

Source Files ¶

View all Source files

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