mindersec / minder / 39495462524
65%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 359
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 64.298%. Remained the same
39495462524

push

github

web-flow 
docs(cli): document stdout vs stderr stream conventions in developer guide (#6923)

* docs(cli): document stdout vs stderr stream conventions

Add CLI Output Stream Conventions to the developer guide and reference it from CONTRIBUTING.md and get-hacking.md.

Documents stdout usage for structured payloads, tables, and tokens, and stderr usage for warnings, errors, interactive prompts, and mutation notices.

Signed-off-by: Ravindra Kumar Bundela <ravindrabundela1205@gmail.com>

* docs(cli): address review feedback on stream conventions guide

Update CLI stream documentation to:

- Clarify that Cobra convenience printers (cmd.Print*) delegate to OutOrStderr and advise using fmt.Fprint*(cmd.OutOrStdout(), ...) for payloads.

- Clarify ExpectedStderr checks substring matching via assert.Contains.

- Correct stream isolation expectations for read-only vs mutation commands.

- Use a concrete example for mutation notices (Updated repository foo/bar).

Signed-off-by: Ravindra Kumar Bundela <ravindrabundela1205@gmail.com>

* docs(cli): address review feedback from evankanderson

- Clarify stream conventions apply to client code in get-hacking.md
- Refine piping motivation on stdout
- Add guidance on progress indicators (5-10s interval, batching thresholds)
- Explain action success notices on stderr are not for machine processing
- Add verbose / debug logging category on stderr
- Mention updating golden files using the -update flag

Signed-off-by: Ravindra Kumar Bundela <ravindrabundela1205@gmail.com>

* docs(cli): clarify stream isolation verification in test guidelines

Signed-off-by: Ravindra Kumar Bundela <ravindrabundela1205@gmail.com>

---------

Signed-off-by: Ravindra Kumar Bundela <ravindrabundela1205@gmail.com>

22752 of 35385 relevant lines covered (64.3%)

54.98 hits per line

Jobs
ID Job ID Ran Files Coverage
1 39495462524.1 359
64.3
GitHub Action Run
Source Files on build 39495462524