Skip to content

Mention pr checks in pr status docs #1807

@StephenGregory

Description

@StephenGregory

This issue covers adding hints to the usage information for pr status about pr checks. This requires adding a Long section to the cobra.Command{} invocation (or perhaps Examples).

Original body:


Describe the feature or problem you’d like to solve

When listing all PRs relevant to me (e.g. gh pr status), I'd like a flag to see a long version of the check results instead running gh pr checks <PR number> for each PR.

Proposed solution

Add a flag, to be used by gh pr status and/or gh pr list.

Perhaps another option to hide the extra details on the passing ones, if one doesn't care for it.

# Viewing the status of your relevant pull requests
~/Projects/my-project$ gh pr status --long
Current branch
  #12 Remove the test feature [user:patch-2]
   - All checks failing - Review required
    - X  Check 1
    - X   Check 2             https://link.to.check.results.com/12

Created by you
  You have no open pull requests

Requesting a code review from you
  #13 Fix tests [branch]
  - 3/4 checks failing - Review required
    - X  Check 1
    - ✓  Check 2             https://link.to.check.results.com/13
  #15 New feature [branch]
   - Checks passing - Approved

~/Projects/my-project$

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsenhancementa request to improve CLIgh-prrelating to the gh pr commandhelp wantedContributions welcome

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions