update

Documentation

Index

• Variables
• func Update(cCtx *cli.Context) error

Variables

var Cmd = &cli.Command{
	Name:  "update-changelog",
	Usage: "Incorporates a changelog.yaml into a complete CHANGELOG.md.",
	Flags: []cli.Flag{
		&cli.StringFlag{
			Name:     markdownPathFlag,
			EnvVars:  common.EnvFor(markdownPathFlag),
			Usage:    "Path to the destination markdown file.",
			Value:    "CHANGELOG.md",
			Required: true,
		},
		&cli.StringFlag{
			Name:    versionFlag,
			EnvVars: common.EnvFor(versionFlag),
			Usage: "Version to stamp in the changelog section header. " +
				"If omitted, no version header will be generated.",
			Value: "",
		},
		&cli.TimestampFlag{
			Name:    dateFlag,
			EnvVars: common.EnvFor(dateFlag),
			Usage: "Date to stamp in the changelog section header, in YYYY-MM-DD format. " +
				"If empty it will default to the current time (time.Now()).",
			Value:  cli.NewTimestamp(time.Now()),
			Layout: "2006-01-02",
		},
	},
	Action: Update,
}

Cmd is the cli.Command object for the update-changelog command.

Functions

func Update

func Update(cCtx *cli.Context) error

Update is a command function which loads a changelog.yaml file and merges it into an existing CHANGELOG.md document.