ghrn

Documentation

Index

• func BuildReleaseNotes(ctx context.Context, w io.Writer, conf Config) error
• type Config

Functions

func BuildReleaseNotes

func BuildReleaseNotes(ctx context.Context, w io.Writer, conf Config) error

BuildReleaseNotes lists GitHub Pull Requests and writes formatted release notes to the given writer.

Types

type Config

type Config struct {
	// Org is the name of the GitHub organization. Required.
	Org string
	// Repo is the name of the GitHub repository. Required.
	Repo string

	// GitHubToken is a GitHub API access token.
	GitHubToken string

	// StopAt is the number of the Pull Request to stop at.
	// Useful for building the notes of PRs since the last release, for example.
	StopAt int
	// IncludeCommits will include commmits messages for each PR.
	IncludeCommits bool
	// SinceLatestRelease will only include PRs and commits merged since the latest release tag.
	SinceLatestRelease bool
	// IncludeAuthor will prefix the message with an author of the PR
	IncludeAuthor bool
}

Config describes configuration for BuildReleaseNotes.