ci: add documentation for the bridge option

Wherever the --bridge option is available an example should be present in the documentation. Add it in the --help doc for every ci command where the new option has any effect. Signed-off-by: Bruno Meneguele <bmeneg@redhat.com>
zaquestion · Aug 10, 2021 · 94f5faa · 94f5faa
1 parent c37e266
commit 94f5faa
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 4 deletions.
diff --git a/cmd/ci_artifacts.go b/cmd/ci_artifacts.go
@@ -26,7 +26,8 @@ var ciArtifactsCmd = &cobra.Command{
 	Example: heredoc.Doc(`
 		lab ci artifacts upstream feature_branch
 		lab ci artifacts upstream 125 --merge-request
-		lab ci artifacts upstream 125:'my custom stage' --merge-request`),
+		lab ci artifacts upstream 125:'my custom stage' --merge-request
+		lab ci artifacts upstream 125:'build' --merge-request --bridge 'security-tests'`),
 	PersistentPreRun: labPersistentPreRun,
 	Run: func(cmd *cobra.Command, args []string) {
 		var (

diff --git a/cmd/ci_status.go b/cmd/ci_status.go
@@ -23,7 +23,8 @@ var ciStatusCmd = &cobra.Command{
 	Example: heredoc.Doc(`
 		lab ci status
 		lab ci status upstream 608 --merge-request
-		lab ci status 600 --wait`),
+		lab ci status 600 --wait
+		lab ci status upstream 125 --merge-request --bridge 'security-tests'`),
 	RunE:             nil,
 	PersistentPreRun: labPersistentPreRun,
 	Run: func(cmd *cobra.Command, args []string) {

diff --git a/cmd/ci_trace.go b/cmd/ci_trace.go
@@ -36,7 +36,8 @@ var ciTraceCmd = &cobra.Command{
 	Example: heredoc.Doc(`
 		lab ci trace upstream feature_branch
 		lab ci trace upstream 18 --merge-request
-		lab ci trace upstream 18:'my custom stage' --merge-request`),
+		lab ci trace upstream 18:'my custom stage' --merge-request
+		lab ci trace upstream 18:'my custom stage' --merge-request --bridge 'security-tests'`),
 	PersistentPreRun: labPersistentPreRun,
 	Run: func(cmd *cobra.Command, args []string) {
 		var (

diff --git a/cmd/ci_view.go b/cmd/ci_view.go
@@ -45,7 +45,8 @@ var ciViewCmd = &cobra.Command{
 		'c' to cancel job`),
 	Example: heredoc.Doc(`
 		lab ci view
-		lab ci view upstream --merge-request`),
+		lab ci view upstream --merge-request
+		lab ci view upstream --merge-request --bridge 'security-tests'`),
 	PersistentPreRun: labPersistentPreRun,
 	Run: func(cmd *cobra.Command, args []string) {
 		a := tview.NewApplication()