fix the --filename option`

[shivnagarajan]

Usage:
  krane render

Options:
      [--bindings=foo=bar abc=def]                                               # Bindings for erb
  f, [--filenames=config/deploy/production config/deploy/my-extra-resource.yml]  # Directories and files to render
      [--stdin], [--no-stdin]                                                    # Read resources from stdin
      [--current-sha=SHA]                                                        # Expose SHA `current_sha` in ERB bindings

Render templates

the --filename option needs to be --filenames to be consistent with the code/usage description.

What are you trying to accomplish with this PR?
...

How is this accomplished?
...

What could go wrong?
...

[RyanBrushett]

Good eye Shiv.
For reference everyone else, see https://github.com/Shopify/krane/blob/master/lib/krane/cli/render_command.rb#L8

[KnVerey]

Actually the design doc has it as singular, which is mirroring kubectl's arg:

 -f, --filename=[]: Filename, directory, or URL to files identifying the resource to get from a server.
 -f, --filename=[]: that contains the configuration to apply
 -f, --filename=[]: Filename, directory, or URL to files to use to create the resource

That makes more sense when the way to add multiple files is to repeat the arg, which we couldn't do because of the Thor bug... but that's fixed upsteam, right?

[RyanBrushett]

Yeah you're right, something to fix when we do the Thor bump.
As of today though, --filenames is what the render command actually takes as an arg tho so the docs should probably reflect that. Worth making note of fixing this as part of #658?

[shivnagarajan]

Yeah you're right, something to fix when we do the Thor bump.
As of today though, --filenames is what the render command actually takes as an arg tho so the docs should probably reflect that. Worth making note of fixing this as part of #658?

How would a future fix handle the case for clients that already use --filenames (plural) instead of --filename

e.g. https://github.com/Shopify/shopify-core-mcrouter/pull/84, I could just use -f instead for now, but I am thinking of any one else that could already have versions that use --filenames

[RyanBrushett]

Hmm indeed, cutting that over would be a breaking change. Maybe an alias could be an option?

[shivnagarajan]

Should I merge this? or just close it?

[dturn]

Our docs should match reality, we can discuss adding an additional alias for --filename in a new issue.