redpanda-data / redpanda-data/benthos
Misleading service.CLIOptCustomRunFlags
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 571
- Forks
- 120
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 18
Description
The sevice.CLIOptCustomRunFlags is misleading, it makes you think you are adding the "run" subcommand flag, that is managed internally by Benthos, but in reality the CustomRunFlags is appended to RunFlags function results.
// RunFlags is the full set of root level flags that have been deprecated and
// are now documented at each subcommand that requires them.
func RunFlags(opts *CLIOpts, hidden bool) []cli.Flag
In the end flags added this way are global flags.
GLOBAL OPTIONS:
--version, -v display version info, then exit (default: false)
--secrets env: [ --secrets env: ] Attempt to load secrets from a provided URN. If more than one entry is specified they will be attempted in order until a value is found. Environment variable lookups are specified with the URN env:, which by default is the only entry. In order to disable all secret lookups specify a single entry of `none:`. (default: "env:")
--redpanda-license /etc/redpanda/redpanda.license Provide an explicit Redpanda License, which enables enterprise functionality. By default licenses found at the path /etc/redpanda/redpanda.license are applied.
--chroot value Chroot into the provided directory, after parsing configuration.
--disable-telemetry Disable anonymous telemetry from being emitted by this Connect instance. (default: false)
--rpc-plugins value [ --rpc-plugins value ] Plugins to load over the RPC interface. This flag should point to manifest files containing the plugin definitions. Globs are also supported.
--help, -h show help
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the repository for service.CLIOptCustomRunFlags, CustomRunFlags, and RunFlags to find their definitions and call sites. Trace how the flags are assembled and exposed in the CLI help, then rename or clarify the misleading option consistently and update any affected tests or documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100