STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Describe bucket and state JSON fields in pr checks command

Browse source 
While the `state` field corresponds 1:1 with different GitHub Actions
states, the `bucket` field is an abstraction of the CLI that lacked
documentation. This both adds documentation about the existence of the
`bucket` field and enumerates the possible values.
This commit is contained in:
Arun 2024-08-08 21:27:35 -07:00 • committed by Tyler McGoffin
parent 1886fb46ab
commit 800f99d9fa
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
pkg/cmd/pr/checks/checks.go
View file

@ -61,15 +61,18 @@ func NewCmdChecks(f *cmdutil.Factory, runF func(*ChecksOptions) error) *cobra.Co
cmd := &cobra.Command{
Use: "checks [<number> | <url> | <branch>]",
Short: "Show CI status for a single pull request",
Long: heredoc.Doc(`
Long: heredoc.Docf(`
Show CI status for a single pull request.
Without an argument, the pull request that belongs to the current branch
is selected.
When the %[1]s--json%[1]s flag is used, it includes a %[1]sbucket%[1]s field, which categorizes
the %[1]sstate%[1]s field into %[1]spass%[1]s, %[1]sfail%[1]s, %[1]spending%[1]s, %[1]sskipping%[1]s, or %[1]scancel%[1]s.
Additional exit codes:
8: Checks pending
`),
`, "`"),
Args: cobra.MaximumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
opts.Finder = shared.NewFinder(f)