annotations

package
v0.21.4 Latest Latest
Warning

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

Go to latest
Published: Nov 19, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package annotations names the trailers colophon acts on, and reports the ones a commit wrote where colophon cannot read them.

It exists so the list lives in one place. The three are read by three packages that must not depend on each other — policy decides versions, notes reads prose, apply writes to a forge — and a list maintained in each caller is the shape that let `apply` ship missing from one (colophon#15).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Keys

func Keys() []string

Keys are every trailer colophon acts on.

func Orphaned

func Orphaned(commits []Commit) []string

Orphaned returns one warning per commit that carries an annotation outside its trailer block, where it decides nothing (spec 0013 D3).

A warning rather than a refusal: a message may quote an annotation in prose, and refusing would make a repository unreleasable over a commit already on its branch.

Types

type Commit

type Commit struct {
	SHA  string
	Body string
}

Commit is the minimum this package needs.

Jump to

Keyboard shortcuts

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