From 94f5faa0445bf8a5ca6ce49363a3d97eabecdcb9 Mon Sep 17 00:00:00 2001 From: Bruno Meneguele Date: Tue, 10 Aug 2021 19:43:56 -0300 Subject: [PATCH] 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 --- cmd/ci_artifacts.go | 3 ++- cmd/ci_status.go | 3 ++- cmd/ci_trace.go | 3 ++- cmd/ci_view.go | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/cmd/ci_artifacts.go b/cmd/ci_artifacts.go index 9129b639..1d4dc3d2 100644 --- 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 index f6ae4ddb..11be8852 100644 --- 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 index b14fa799..5bdc94a1 100644 --- 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 index 78ddac68..8f6b1b87 100644 --- 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()