issue

package
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Sep 24, 2026 License: BSD-3-Clause Imports: 4 Imported by: 0

Documentation

Overview

Package issue verifies that commit message, represented by a file, has a reference to the issue, i.e., either `NO_ISSUE` or `Issue #123` line, ignoring case. The issue number can also have `user/repo#123` form.

Index

Constants

This section is empty.

Variables

View Source
var ErrNoIssue = errors.New("missing issue")

ErrNoIssue means missing issue reference.

Functions

func Check

func Check(b []byte) error

Check verifies that the buffer b has an valid issue reference. A valid issue reference (ignore case) is separate on the line and has one of the forms:

no_issue
verb reference

where verb is one of `issue`, `close`, `fix` and reference is either `#123` or `owner/repo#123`.

Examples:

NO_ISSUE
Issue #123
Close user/repo#123

func Run

func Run(files []string) error

Run verifies that the files has an issue reference.

Types

This section is empty.

Jump to

Keyboard shortcuts

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