Examples for "pipeline list" and "ci list" display --state instead of --status argument
Created by: turbobastii
Description
When running glab pipeline list --help
or glab ci list --help
the returned examples document the --status
argument as --state
. The options overview is however correct.
Expected Behavior vs Actual Behavior
Expected:
glab pipeline list --help
returns the example $ glab pipeline list --status=failed
Actual:
glab pipeline list --help
returns the example $ glab pipeline list --state=failed
Possible Fix
Can be easily fixed by updating corresponding .rst
files.
Steps to Reproduce
- Type this 'glab pipeline list --help'
- The output in the examples section is '$ glab pipeline list --state=failed'
Logs
C:\>glab pipeline list --help
Get the list of CI pipelines
USAGE
glab ci list [flags]
FLAGS
-o, --orderBy string Order pipeline by <string>
-p, --page int Page number (default 1)
-P, --per-page int Number of items to list per page. (default 30) (default 30)
--sort string Sort pipeline by {asc|desc}. (Defaults to desc) (default "desc")
-s, --status string Get pipeline with status: {running|pending|success|failed|canceled|skipped|created|manual}
INHERITED FLAGS
--help Show help for command
-R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL
EXAMPLES
$ glab ci list
$ glab ci list --state=failed
LEARN MORE
Use 'glab <command> <subcommand> --help' for more information about a command.
C:\>
Your Environment
- Version used: glab version 1.22.0 (2022-01-10)
- Operating System and version: Microsoft Windows [Version 10.0.22000.493]