Support output json gh pr checks #6056

Activity

1. wzshiming

   added

   enhancementa request to improve CLIa request to improve CLI

   on Aug 11, 2022
2. cliAutomation

   added

   needs-triageneeds to be reviewedneeds to be reviewed

   on Aug 11, 2022
3. vilmibm commented on Aug 11, 2022

   

   vilmibm

   on Aug 11, 2022

   Last edited by vilmibm

   Contributor

   More actions

   I'm not opposed to this, but I would want to see a proposal of what the JSON payload would look like.

   Behind the scenes, gh pr checks is combining data from a few different endpoints. It doesn't cleanly map to a single query with a single JSON payload.

   The central question is if gh pr checks should try and output a single, consistent JSON schema combining the results of action workflow runs and checks or if it should do something like:

   {
     "checks": {},
     "runs": {}
   }

   with the corresponding payloads for checks and runs.

   I'm going to mark this as needs-design and leave it open, but will refrain from encouraging PRs until there is a design consensus.

   turned out to all be wrong based on out of date knowledge, see followup comment
4. vilmibm

   added

   needs-designAn engineering task needs design to proceedAn engineering task needs design to proceed

   and removed

   needs-triageneeds to be reviewedneeds to be reviewed

   on Aug 11, 2022
5. vilmibm commented on Aug 17, 2022

   

   vilmibm

   on Aug 17, 2022

   Contributor

   More actions

   I've refreshed myself on the code for pr checks and remembered that it's now using the status check rollup that combines checks and runs into a single list ^_^()

   My previous comment can be ignored and I'm ok with a PR that gives the --json treatment to the StatusCheckRollup payload.

   👍React with 👍1Reacted by Shiming Zhang

   🎉React with 🎉1Reacted by Shiming Zhang
6. vilmibm

   added

   help wantedContributions welcomeContributions welcome

   and removed

   needs-designAn engineering task needs design to proceedAn engineering task needs design to proceed

   on Aug 17, 2022
7. redhoyasa commented on Aug 17, 2022

   

   redhoyasa

   on Aug 17, 2022

   More actions

   I'm interested to work on this.

   As I observe that gh pr checks also does some aggregations, I think we should also put this in the JSON payload.

   My proposed payload:

   {
     "summary": {
       "failed": 0,
       "passed": 1,
       "pending": 1,
       "skipping": 1
     },
     "checkruns": [
       {
         "completedAt": "...",
         "conclusion": "...",
         "detailsUrl": "...",
         "name": "...",
         "startedAt": "...",
         "status": "...",
         "workflowName": "..."
       }
       // more checkruns here
     ]
   }

   wdyt?
8. mislav commented on Oct 24, 2022

   

   mislav

   on Oct 24, 2022

   Contributor

   More actions

   Ref. #3558 #4002 #4916
9. darthwalsh commented on Jun 30, 2023

   

   darthwalsh

   on Jun 30, 2023

   Contributor

   More actions

   This would be useful!

   Right now if you try to parse the output in a script, e.g. grep for success: gh pr checks 123 | grep '✓'
   ...you find out the CLI output changes to instead print tab-separated pass and the nice emojis are gone.

   👍React with 👍1Reacted by Jason Mobarak
10. risset commented on Jul 18, 2023

    

    risset

    on Jul 18, 2023

    More actions

    Would it be practical to get check run outputs here too? I'm interested in being able to retrieve why a particular check is failing
11. wildan3105 commented on Sep 20, 2023

    

    wildan3105

    on Sep 20, 2023

    More actions

    hi @redhoyasa, are you still actively working on this?

    👍React with 👍1Reacted by Josef Trejbal
12. andyfeller

    added

    gh-prrelating to the gh pr commandrelating to the gh pr command

    on Oct 2, 2023
13. andyfeller

    closed this as completedin #9079on May 16, 2024