bcgov / bcgov/gwa-cli

Decide on flags or positional arguments for `gwa config set` commands

Open
#115 1 comment 0 reactions 0 assignees View on GitHub
jira
Dominant language
Go
Stars
8
Forks
1
PR merge metrics
No merged PRs in 30d

Description

It seems unnecessary and potentially confusing that we support both `config set [key]` and `config set --[key]` (as a flag) for all the values you can set.

This results in the internal docs being oddly duplicative:
![image](https://github.com/bcgov/gwa-cli/assets/38586679/f9192352-b1da-45d9-b725-8df463d8cd27)

Fix:
- decide on one approach - see pros and cons in https://chatgpt.com/share/5854e6d1-efdd-42b4-89c7-3baf4edf90c5
- `oc` uses positional args for this - see https://docs.openshift.com/container-platform/4.8/cli_reference/openshift_cli/developer-cli-commands.html#oc-config-set
- `kubectl` also uses positional args (tho it is `set-[key]`) - https://kubernetes.io/docs/reference/kubectl/quick-reference/#kubectl-context-and-configuration
- If going with positional args:
- Remove the keys as available flags.
- Remove `[flags]` from example usage.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.