refactor: Make CLI argument names consistent

[gabyx]

• Rename --snapshotMode and --customPlatform.

Description

Small refactor to make CLI arguments consistent.

Reviewer Notes

• [ ] The code flow looks good.

Release Notes

Describe any changes here so maintainer can include it in the release notes, or delete this block.

Examples of user facing changes:
- Flag `--snapshotMode` is now called `--snapshot-mode`.
- Flag `--customPlatform` is now called `--custom-platform`.

[gabyx]

Ah did not know about this, in cobra.

[gabyx]

@imjasonh: I guess now the PR should be good to go.

[gabyx]

@imjasonh Lets see if the tests run through. They should... Didnt change anything...

[glennakamura]

Is there a reason the --tarPath option wasn't changed to --tar-path?

[imjasonh]

Is there a reason the --tarPath option wasn't changed to --tar-path?

Probably not.

It'd be worth aligning this as well, if anyone's interested in doing it.

[gabyx]

I ll do it! :) Sorry probably a mistake. BR

Von meinem iPhone gesendet

Am 13.08.2022 um 04:16 schrieb Jason Hall @.***>:

 Is there a reason the --tarPath option wasn't changed to --tar-path?

Probably not.

It'd be worth aligning this as well, if anyone's interested in doing it.

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.

[gabyx]

@imjasonh: Its fixed now.

Also: I formatted the Readme markdown with prettier. Which is now 80 lines and consistent. Also: I made the argument section a bit nicer.

[gabyx]

@imjasonh: I have no idea why the executor crashes saying --customPlatform is deprecated?? We are not using this argument...? Do you see it?

[gabyx]

@imjasonh: This can be merged now, thanks :)

I formatted all markdowns, to better have diffs when people add documentation.

[gabyx]

@imjasonh Jeah totally right, we just map the values.

[gabyx]

@imjasonh: I changed the bahv. to warning.

Made a note that we should make it deprecated in v2.0.0. Is there a notes file for v2.0.0 to list all things which might be noeted? Maybe there is also a global GO file to make such a variabel, such that we can add checks, and once we are at 2.0.0 we can set it to true and check all places and refactor them.

[imjasonh]

Made a note that we should make it deprecated in v2.0.0. Is there a notes file for v2.0.0 to list all things which might be noeted? Maybe there is also a global GO file to make such a variabel, such that we can add checks, and once we are at 2.0.0 we can set it to true and check all places and refactor them.

I don't think we need to wait for a full v2, so long as there's ample time to switch, and clear instructions how. I think that's satisfied here.

If you want to file an issue to remind us all to complete the migration after the next release (v1.10), that sounds fine. Otherwise I think there's enough context in the code and history to come back and remove it later.

Thanks for doing this!

[acohenOT]

README still lists the deprecated parameter. Can this be fixed? https://github.com/GoogleContainerTools/kaniko#flag---snapshotmode