announce

package
v0.11.0 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2026 License: MIT Imports: 21 Imported by: 0

Documentation

Overview

Package announce implements the `announce` verb: tell people a release happened, through the adapters .colophon.yaml configures.

Index

Constants

This section is empty.

Variables

View Source
var ErrNoRelease = errors.New("announce: no release to announce")

ErrNoRelease reports a tag carrying no release object. Announcing one that does not exist would put out a link to nothing.

View Source
var ErrTagRequired = errors.New("announce: --tag names the release to announce")

ErrTagRequired reports a run with no release named.

View Source
var ErrUnknownAdapter = errors.New("announce: no such adapter")

ErrUnknownAdapter reports an adapter the manifest names and colophon does not have.

Functions

func NewCmdAnnounce

func NewCmdAnnounce(props *props.Props) *setup.Command

func Run

func Run(ctx context.Context, p *props.Props, opts *AnnounceOptions, w io.Writer) error

Run is RunAnnounce with its output injected.

func RunAnnounce

func RunAnnounce(ctx context.Context, p *props.Props, opts *AnnounceOptions, _ []string) error

RunAnnounce is the `announce` verb.

Types

type AnnounceOptions

type AnnounceOptions struct {
	Tag         string
	Forge       string
	Repo        string
	Remote      string
	AuthorName  string
	AuthorEmail string
}

Jump to

Keyboard shortcuts

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