step

Documentation

Index

• Variables

Variables

var GetCmd = cli.Command{
	Name:        "step",
	Aliases:     []string{"steps"},
	Description: "Use this command to get a list of steps.",
	Usage:       "Display a list of steps",
	Action:      get,
	Before:      validate,
	Flags: []cli.Flag{

		cli.StringFlag{
			Name:   "org",
			Usage:  "Provide the organization for the repository",
			EnvVar: "BUILD_ORG",
		},
		cli.StringFlag{
			Name:   "repo",
			Usage:  "Provide the repository contained with the organization",
			EnvVar: "BUILD_REPO",
		},
		cli.IntFlag{
			Name:   "build-number,build,b",
			Usage:  "Provide the build number",
			EnvVar: "BUILD_NUMBER",
		},

		cli.IntFlag{
			Name:  "page,p",
			Usage: "Print a specific page of steps",
			Value: 1,
		},
		cli.IntFlag{
			Name:  "per-page,pp",
			Usage: "Expand the number of items contained within page",
			Value: 10,
		},
		cli.StringFlag{
			Name:  "output,o",
			Usage: "Print the output in wide, yaml or json format",
		},
	},
	CustomHelpTemplate: fmt.Sprintf(`%s
EXAMPLES:
 1. Get steps for a build.
    $ {{.HelpName}} --org github --repo octocat --build-number 1
 2. Get steps for a build with wide view output.
    $ {{.HelpName}} --org github --repo octocat --build-number 1 --output wide
 3. Get steps for a build with yaml output.
    $ {{.HelpName}} --org github --repo octocat --build-number 1 --output yaml
 4. Get steps for a build with json output.
    $ {{.HelpName}} --org github --repo octocat --build-number 1 --output json
 5. Get steps for a build when org and repo config or environment variables are set.
    $ {{.HelpName}} --number 1
`, cli.CommandHelpTemplate),
}

GetCmd defines the command for getting a list of steps.

var ViewCmd = cli.Command{
	Name:        "step",
	Description: "Use this command to view a step.",
	Usage:       "View details of the provided step",
	Action:      view,
	Before:      validate,
	Flags: []cli.Flag{

		cli.StringFlag{
			Name:   "org",
			Usage:  "Provide the organization for the repository",
			EnvVar: "BUILD_ORG",
		},
		cli.StringFlag{
			Name:   "repo",
			Usage:  "Provide the repository contained with the organization",
			EnvVar: "BUILD_REPO",
		},
		cli.IntFlag{
			Name:   "build-number,build,b",
			Usage:  "Provide the build number",
			EnvVar: "BUILD_NUMBER",
		},
		cli.IntFlag{
			Name:   "step-number,step,s",
			Usage:  "Provide the step number",
			EnvVar: "STEP_NUMBER",
		},

		cli.StringFlag{
			Name:  "output,o",
			Usage: "Print the output in json format",
		},
	},
	CustomHelpTemplate: fmt.Sprintf(`%s
EXAMPLES:
 1. Get step details for a repository.
    $ {{.HelpName}} --org github --repo octocat --build-number 1 --step-number 1
 2. Get step details for a repository with json output.
    $ {{.HelpName}} --org github --repo octocat --build-number 1 --step-number 1 --output json
 3. Get step details for a repository when org and repo config or environment variables are set.
    $ {{.HelpName}} --build-number 1 --step-number 1
`, cli.CommandHelpTemplate),
}

ViewCmd defines the command for viewing a step.