Skip to content

Commit

Permalink
Merge pull request #251 from CircleCI-Public/orb-process-docs
Browse files Browse the repository at this point in the history
[CIRCLE-15447]: Add more details to `circleci help orb process`
  • Loading branch information
Zachary Scott authored Jan 4, 2019
2 parents 25ba6fb + e64908f commit 5d9bb5d
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions cmd/orb.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,11 @@ func newOrbCommand(config *settings.Config) *cobra.Command {
processCommand := &cobra.Command{
Use: "process <path>",
Short: "Validate an orb and print its form after all pre-registration processing",
Long: strings.Join([]string{
"You can use `$ circleci orb process` to resolve an orb, and it's dependencies to see how it would be expanded when you publish it to the registry.",
"", // purposeful new-line
"This can be helpful for validating an orb and debugging the processed form before publishing",
}, "\n"),
PreRun: func(cmd *cobra.Command, args []string) {
opts.args = args
opts.cl = client.NewClient(config.Host, config.Endpoint, config.Token, config.Debug)
Expand All @@ -90,6 +95,7 @@ func newOrbCommand(config *settings.Config) *cobra.Command {
Args: cobra.ExactArgs(1),
Annotations: make(map[string]string),
}
processCommand.Example = ` circleci orb process src/my-orb/@orb.yml`
processCommand.Annotations["<path>"] = orbAnnotations["<path>"]

publishCommand := &cobra.Command{
Expand Down

0 comments on commit 5d9bb5d

Please sign in to comment.