link

Documentation

Index

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

Variables

var Cmd = &cli.Command{
	Name:      "link-changelog",
	Usage:     "Adds links to the original changelog for all the dependencies in a changelog.yml detecting the link if the name is a full route or getting the link from a dictionary file if present",
	UsageText: `Link Changelog retrieves the links for each dependency detecting the link if the name is a full route or matching an entry in the dictionary file.`,
	Flags: []cli.Flag{
		&cli.StringFlag{
			Name:    dictionaryPathFlag,
			EnvVars: common.EnvFor(dictionaryPathFlag),
			Usage: "Path to a dictionary file mapping dependencies to their changelogs. " +
				"A dictionary is a YAML file with a root dictionary object, which contains a map from " +
				"dependency names to a template that will be rendered into a URL pointing to its changelog." +
				"The template link must be in Go tpl format and typically will include the {{.To.Original}} variable" +
				"that will be replaced by the last bumped version (execute link-changelog with --sample flag to see a dictionary.yml sample)",
			Value: "",
		},
		&cli.BoolFlag{
			Name:    sampleFlag,
			EnvVars: common.EnvFor(sampleFlag),
			Usage:   "Prints a sample dictionary to stdout.",
		},
	},
	Action: Link,
}

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

Functions

func Link

func Link(cCtx *cli.Context) error

Link is a command function which tries to add a link to the changelog of each dependency in a changelog computing them from each of the defined mappers.