[I] The `atr check status` --verbose flag has no effect (tooling-releases-client)

["potiuk (via GitHub)" <gi...@apache.org>]

potiuk opened a new issue, #36:
URL: https://github.com/apache/tooling-releases-client/issues/36

   currently when you run `atr check status`, the `--verbose` option has no effect.
   
   The ouptut is the same:
   
   ```
   ⏚ [jarekpotiuk:/private/ … 503-eff40469f569/scratchpad/magpie-rc2] % atr check status   magpie "${VERSION}" --verbose
   Total checks: 7
     note: 7
   ```
   
   ```
   ⏚ [jarekpotiuk:/private/ … 503-eff40469f569/scratchpad/magpie-rc2] % atr check status   magpie "${VERSION}"
   Total checks: 7
     note: 7
   ```
   
   Also the output does not really tell much - I saw it also in-progress:
   
   ```
   ⏚ [jarekpotiuk:/private/ … 503-eff40469f569/scratchpad/magpie-rc2] 25s % atr check status   magpie "${VERSION}" --verbose
   Total checks: 6
     note: 6
   ```
   
   And to be honest, I am not sure what "status" output can be useful for. I would imagine it could print:
   
   * 6/7 - still running 
   * 7 successful
   * all checks passed
   
   Or something similar. Currently the output is not very 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@tooling.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] The `atr check status` --verbose flag has no effect (tooling-releases-client)

["sbp (via GitHub)" <gi...@apache.org>]

sbp commented on issue #36:
URL: https://github.com/apache/tooling-releases-client/issues/36#issuecomment-4958985408

   We have [existing documentation on the check result levels](https://release-test.apache.org/docs/checks#understanding-check-results):
   
   > A note indicates that the check ran and has nothing substantial to report.
   
   Perhaps we should link to the documentation in the output, but that is only useful the first time and then redundant for every subsequent use. I think that in general we expect users to look things up in the documentation themselves. We plan a complete redesign of the user documentation of ATR soon, but this point was already documented, so I'd be interested to know what you suggest we do here, or whether the existing documentation is sufficient.
   
   The `--verbose` flag works for everything but notes.
   
   I could probably rework `check status` entirely. It doesn't currently give the processing status, as you say, and perhaps little brief notes of what each check result status means (like `note (all good, no action required)`) would be a good resolution to the documentation puzzle.
   
   In general, I was intending this command to be useful for polling from a script to see when the checks have completed. A simple boolean would be enough to satisfy that, but I figured that the extra information might be helpful somewhere. It was probably helpful to me in debugging already, though it's been a while since I worked on this.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@tooling.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] The `atr check status` --verbose flag has no effect (tooling-releases-client)

["potiuk (via GitHub)" <gi...@apache.org>]

potiuk commented on issue #36:
URL: https://github.com/apache/tooling-releases-client/issues/36#issuecomment-4953089317

   I checked in other revision and it is a bit more useful when there are errors:
   
   ```
   Total checks: 7
     blocker: 1
     note: 6
   ```
   
   But I think it would be useful to say more - I am not sure what "note" means :( 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@tooling.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org