search

spinnaker / roer

A thin Spinnaker CLI
Apache License 2.0
45 stars 45 forks source link

plan subcommand's docs are misleading #19

Open davidxia opened 6 years ago

davidxia commented 6 years ago

The help message for roer pipeline-template plan are misleading. It says

validate a pipeline template and or plan a configuration",

        Given a pipeline template configuration, a plan operation
        will be run, with either the errors being returned or the
        final pipeline JSON that would be executed.

But the output of this command isn't the final pipeline that would be produced compared to roer pipeline save. plan's output is missing configuration like triggers. What's the intended use of plan and what would an accurate help message be?

See https://gist.github.com/davidxia/462dfa23b63528ddb12b9caf2cbda039#file-result-of-publishing-and-planning for an example of the difference between plan and save.

davidxia commented 6 years ago

cc @danielhan @caipre in case you get tripped up by this.