config

Documentation

Index

• Variables
• type BetaRelease
• type Config
  • func NewConfig(c *cli.Context) *Config

Variables

var CliFlags = []cli.Flag{
	&cli.StringFlag{
		Name:     "token",
		Usage:    "github token",
		EnvVars:  []string{"GITHUB_TOKEN", "GH_TOKEN"},
		Required: true,
	},
	&cli.StringFlag{
		Name:     "slug",
		Usage:    "slug of the repository",
		EnvVars:  []string{"GITHUB_REPOSITORY", "TRAVIS_REPO_SLUG"},
		Required: true,
	},
	&cli.StringFlag{
		Name:  "changelog",
		Usage: "creates a changelog file",
	},
	&cli.BoolFlag{
		Name:  "ghr",
		Usage: "create a .ghr file with the parameters for ghr",
	},
	&cli.BoolFlag{
		Name:  "noci",
		Usage: "run semantic-release locally",
	},
	&cli.BoolFlag{
		Name:  "dry",
		Usage: "do not create release",
	},
	&cli.BoolFlag{
		Name:  "vf",
		Usage: "create a .version file",
	},
	&cli.StringFlag{
		Name:  "update",
		Usage: "updates the version of a certain file",
	},
	&cli.StringFlag{
		Name:    "ghe-host",
		Usage:   "github enterprise host",
		EnvVars: []string{"GITHUB_ENTERPRISE_HOST"},
	},
	&cli.BoolFlag{
		Name:  "prerelease",
		Usage: "flags the release as a prerelease",
	},
	&cli.BoolFlag{
		Name:  "travis-com",
		Usage: "force semantic-release to use the travis-ci.com API endpoint",
	},
	&cli.StringFlag{
		Name:  "match",
		Usage: "Only consider tags matching the given glob(7) pattern, excluding the \"refs/tags/\" prefix.",
	},
}

CliFlags cli flags

Types

type BetaRelease

type BetaRelease struct {
	MaintainedVersion string `json:"maintainedVersion"`
}

type Config

type Config struct {
	Token       string
	Slug        string
	Changelog   string
	Ghr         bool
	Noci        bool
	Dry         bool
	Vf          bool
	Update      string
	GheHost     string
	Prerelease  bool
	TravisCom   bool
	BetaRelease BetaRelease
	Match       string
}

Config is a complete set of app configuration

func NewConfig

func NewConfig(c *cli.Context) *Config

NewConfig returns a new Config instance