bregctl usage errors repeat a rejected argument value, including --operator-reference
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
Research direction
Start in crates/registry-bregctl/src/lib.rs at the usage.invalid path in main, and compare the existing value-free diagnostic pattern used by evidencectl and the caseworkctl/schedulingctl fixes. Add a bregctl test using a sentinel rejected for --operator-reference, then verify the sentinel appears in neither stdout nor stderr for the human and JSON error paths.
Written by the indexing model from the issue text.
Description
bregctl builds its usage-error diagnostic from clap's rendered error (crates/registry-bregctl/src/lib.rs, the usage.invalid path in main), in both human and JSON output. Clap's rendering quotes the rejected value, so a refused or misspelled --operator-reference=VALUE is written back to stdout or stderr in clear. Everywhere else, that value is kept only as a keyed hash.
Exposure is limited to the operator's own terminal and anything capturing its output, such as CI logs. It is still a gap in data minimization.
evidencectl on main already uses a fixed message. The WP3 Casework and Scheduling PR fixes caseworkctl and schedulingctl by building the message from the error kind and the argument name, while keeping our own value-free validator reasons.
Fix: apply the same pattern in bregctl. Add a test that passes a sentinel value clap rejects for --operator-reference and asserts the sentinel appears in neither stdout nor stderr.
Planned with the bregctl half of #1412, which moves bregctl onto the shared ctl report contract.
- Dominant language
- Rust
- Stars
- 2
- Forks
- 0
- Avg merge
- 7h 22m
- Merged PRs (30d)
- 213
Getting set up
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.
More from registrystack/registry-stack
-
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
registrystack/registry-stack#1748 ·
Maintainers usually reply within 1 day
-
area:casework bug criticality:p3 triage:needs-implementation
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
registrystack/registry-stack#1729 ·
Maintainers usually reply within 1 day
-
area:breg bug criticality:p3 triage:needs-implementation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
registrystack/registry-stack#1682 ·
Maintainers usually reply within 1 day
-
area:casework bug criticality:p3 triage:needs-implementation
Difficulty 1/5 Under an hour Newbie friendliness 88/100
registrystack/registry-stack#1669 ·
Maintainers usually reply within 1 day
-
agent-ready area:platform criticality:p3 documentation triage:needs-implementation
Difficulty 1/5 Under an hour Newbie friendliness 90/100
registrystack/registry-stack#1639 ·
Maintainers usually reply within 1 day
All issues in registrystack/registry-stack
Similar issues
-
type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
stackabletech/kafka-operator#1033 · 1 comment ·
Maintainers usually reply within 1 day
-
bug good first issue needs testing
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
farion1231/cc-switch#7744 · 1 comment ·
Maintainers usually reply within 1 day
-
datafusion
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
apache/iceberg-rust#3297 ·
Maintainers usually reply within 1 day