docsgen

Documentation

Index

• Variables
• func Execute(opts Options) error
• type ChangelogConfig
• type ChangelogOptions
• type CliOptions
• type Options
• type ProtoOptions

Variables

var (
	MissingGithubTokenError = errors.New("Must set GITHUB_TOKEN environment variable")
)

Functions

func Execute

func Execute(opts Options) error

Types

type ChangelogConfig

type ChangelogConfig struct {
	Name    string
	Repo    string
	Path    string
	Version string
}

type ChangelogOptions

type ChangelogOptions struct {
	Generate  bool
	Repos     []ChangelogConfig
	OutputDir string
}

type CliOptions

type CliOptions struct {
	RootCmd   *cobra.Command
	OutputDir string
}

type Options

type Options struct {
	Proto     ProtoOptions
	Cli       CliOptions
	Changelog ChangelogOptions
	DocsRoot  string // Will default to docs if empty
}

type ProtoOptions

type ProtoOptions struct {
	ProtoRoot string // Will default to vendor_any if empty
	OutputDir string
}