releasenotes

package
v0.1.2 Latest Latest
Warning

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

Go to latest
Published: Jul 15, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package releasenotes formats release note entries from repository changes.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RenderMarkdown

func RenderMarkdown(w io.Writer, report Report)

Types

type Commit

type Commit struct {
	Hash    string   `json:"hash"`
	Short   string   `json:"short"`
	Date    string   `json:"date"`
	Author  string   `json:"author"`
	Subject string   `json:"subject"`
	Files   []string `json:"files,omitempty"`
}

type Options

type Options struct {
	From  string
	To    string
	Limit int
}

type Report

type Report struct {
	Kind     string    `json:"kind"`
	Action   string    `json:"action"`
	Status   string    `json:"status"`
	From     string    `json:"from,omitempty"`
	To       string    `json:"to"`
	Total    int       `json:"total"`
	Sections []Section `json:"sections"`
	Commits  []Commit  `json:"commits"`
}

func Generate

func Generate(workspace string, options Options) (Report, error)

type Section

type Section struct {
	Name    string   `json:"name"`
	Commits []Commit `json:"commits"`
}

Jump to

Keyboard shortcuts

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