Skip to content

pipeline convert help corrections #649

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcncl merged 5 commits into from
Mar 4, 2026
Merged

pipeline convert help corrections #649

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
301b450
pipeline convert help corrections
karensawrey Feb 16, 2026
86209f1
Vendor path and name clarificaion
karensawrey Feb 16, 2026
18a6fb1
Update cmd/pipeline/convert.go
omehegan Mar 2, 2026
0996092
Merge branch 'main' into TSDOCS-263-CLI-help-fix
mcncl Mar 3, 2026
baedf6f
Merge branch 'main' into TSDOCS-263-CLI-help-fix
mcncl Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions cmd/pipeline/convert.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ type statusResponse struct {
}

type ConvertCmd struct {
File string `help:"Path to the pipeline file to convert (reads from stdin if not specified)" short:"F"`
Vendor string `help:"CI/CD vendor (auto-detected from file path, required when reading from stdin)" short:"v"`
Output string `help:"Custom path to save the converted pipeline (default: stdout for stdin input, .buildkite/pipeline.<vendor>.yml for file input)" short:"o"`
Timeout int `help:"Timeout in seconds for conversion" default:"300"`
File string `help:"Path to the pipeline file to convert (required)" short:"F" required:""`
Vendor string `help:"CI/CD vendor (auto-detected if the file name matches vendor path and name - otherwise, needs to be specified)" short:"v"`
Output string `help:"Custom path to save the converted pipeline (default: .buildkite/pipeline.<vendor>.yml)" short:"o"`
Timeout int `help:"The time (in seconds) after which a conversion should be cancelled" default:"300"`
}

func (c *ConvertCmd) Help() string {
Expand All @@ -62,8 +62,7 @@ Supported vendors:
- harness (Harness CI) (beta)
- bitrise (Bitrise) (beta)

The command will automatically detect the vendor based on the file name if not specified.
When reading from stdin, the --vendor flag is required.
The command will automatically detect the vendor based on the file path and name if not specified.

When using --file, the converted pipeline is saved to .buildkite/pipeline.<vendor>.yml by default.
When reading from stdin, output goes to stdout by default.
Expand Down