docs(breg): configure/breg.mdx lists stages for a request_lifecycle when, which bregctl refuses
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 92/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- rust
- Domain
- documentation
Research direction
Start in docs/site/src/content/docs/configure/breg.mdx at the hooks member table and its when row. Check registry-project.v1alpha1.schema.json and the cited change_request.rs test to confirm the supported request_lifecycle members. Remove stages from the documentation, then verify the example with bregctl check and ensure the row lists only transitions and toStates.
Written by the indexing model from the issue text.
Description
docs/site/src/content/docs/configure/breg.mdx (hooks member table, when row) says a kind: request_lifecycle test takes transitions, toStates, and stages. On v0.34.0 and current main, stages is not an accepted member:
registry-project.v1alpha1.schema.jsonhas onlykind,toStatesandtransitionsfor therequest_lifecycleform ofwhen.crates/registry-breg/src/change_request.rshas the testobsolete_stages_and_application_modes_are_not_authoring_inputs.bregctl checkrefuses it:
# products/breg nursing-register example, with this added to the request_lifecycle hook:
# "when": {"kind": "request_lifecycle", "stages": ["review"]}
$ bregctl check <copy> --format json | jq -c '.diagnostics[] | {code, message}'
{"code":"source.yaml.invalid","message":"the YAML source is structurally invalid: entities[1].hooks[0]: unknown field `stages`, expected `transitions` or `toStates` at line 382 column 9"}
The same hook with "toStates": ["submitted"] passes. Suggested fix: drop , and stages from that row (with transitions and toStates).
Found by bregctl 0.34.0 while auditing breg-skills against the vendored docs.
- Dominant language
- Rust
- Stars
- 2
- Forks
- 0
- Avg merge
- 7h 46m
- Merged PRs (30d)
- 199
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
-
area:breg criticality:p3 documentation triage:needs-implementation
Difficulty 1/5 Under an hour Newbie friendliness 86/100
registrystack/registry-stack#1713 ·
Maintainers usually reply within 1 day
-
area:breg bug criticality:p3 triage:needs-implementation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
registrystack/registry-stack#1699 ·
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
-
area:evidence bug criticality:p3 triage:needs-implementation
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
registrystack/registry-stack#1665 ·
Maintainers usually reply within 1 day
All issues in registrystack/registry-stack
Similar issues
-
backend::vllm diffusion multimodal
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
lambdaclass/ethrex#7329 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
shadowsocks/shadowsocks-rust#2186 · 1 comment ·
-
C-bug S-awaiting-triage
Difficulty 1/5 Under an hour Newbie friendliness 92/100
juspay/hyperswitch#14479 ·
Maintainers usually reply within 1 day