Skip to content
Pando

"Needs you": open branches that are ready, conflicting or failing, and issues assigned to the person, across their monorepos

issues: per monorepo, the open issues assigned to the person, read from each monorepo's summary line (up to 10 s behind; the person's socket's summary frame moves it, its assigned; a large monorepo's is read from it, current), most recently updated first, with the newest one.

Branches: from stored branch facts and statuses (no Artifacts call), asked only of the monorepos whose counts in their summary line are not zero (up to 10 s behind), most recently active first, at most 50 monorepos (the rest in skipped). One state per branch, in this order:

  • conflicts: the stored dry run for the branch's current head conflicts with main;
  • failing: a check on the head failed or errored;
  • ready: facts for the current main and head say clean, and the merge gate's checks pass. Facts are computed for branches pushed in the last 7 days; an older branch that is not re-pushed drops out of ready when main moves. Rows are newest push first.
GET
https://app.gitpando.com/v1/branches
View as Markdown

Authorisation

  • credentialoptionalHTTP
  • sessionoptionalAPI key in cookie

Query parameters

  • stateoptionalopen
    Default: "open"
  • needsoptionalstring

    Comma-separated, some of ready, conflicts, failing (default all three).

    Default: "ready,conflicts,failing"
  • inoptionalstring

    One monorepo's owner/name.

  • limitoptionalinteger
    maximum: 500, minimum: 1
    Default: 100

Returns

200

OK

JSON
  • branchesarray ofobjectrequired
    12 properties
    • monorepostringrequired

      owner/name.

    • monorepo_idstringrequired
    • repostringrequired
    • repo_pathstringrequired
    • branchstringrequired
    • headstringrequired
    • authorstring | nullrequired

      The user whose first push made the branch.

    • pushed_machinestring | nullrequired

      The credential that last pushed it.

    • statereadyorconflictsorfailingrequired
    • checksobjectrequired
      3 properties
      • stateoptionalstring
      • failingoptionalarray ofstring

        Contexts that failed or errored.

      • failing_appsoptionalmap ofstring | null

        For each failing context, the CI service that reported it (app, for its mark), or null when a member posted it.

    • updated_atstring | nullrequired

      The last push.

      format: date-time
    • titleoptionalstring | null
  • issuesarray ofunknownrequired
    4 properties
    • monorepostringrequired

      owner/name.

    • monorepo_idstringrequired
    • countintegerrequired
    • newestobjectrequired
      3 properties
      • numberintegerrequired
      • titlestringrequired
      • updated_atstringrequired
        format: date-time
  • truncatedbooleanrequired
  • skippedarray ofstringrequired

    Monorepos (owner/name) not asked (over 50).

400

An error

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
    • messagestringrequired
    • pathsoptionalarray ofstring
    • checksoptionalobject

      GitHub's combined status, plus the required contexts and which are missing.

      6 properties
      • shastring | nullrequired
      • statesuccessorpendingorfailureorerrorormissingorunknownrequired

        success when the merge gate passes; missing when a required context has not reported; unknown while the required checks are (an unforced merge is refused).

      • requiredarray | nullrequired

        Null while unknown.

      • checks_unknownstring | nullrequired

        Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise.

      • statusesarray ofobjectrequired

        The latest status per context.

        8 properties
        • shastringrequired
        • contextstringrequired
        • statependingorsuccessorfailureorerrorrequired
        • created_atstringrequired
          format: date-time
        • target_urloptionalstring | null
        • descriptionoptionalstring | null
        • creatoroptionalstring

          The member who posted it (a login); app:<slug> for a status posted with a status token or by a CI integration; hook:<hook id> for a status token from a web hook with no app.

        • appoptionalstring | null

          The CI service that reported it (buildkite, github-actions, ...), stamped by Pando from a status token or a CI integration, never from the body or target_url. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows.

      • missingoptionalarray ofstring

404

An error

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
    • messagestringrequired
    • pathsoptionalarray ofstring
    • checksoptionalobject

      GitHub's combined status, plus the required contexts and which are missing.

      6 properties
      • shastring | nullrequired
      • statesuccessorpendingorfailureorerrorormissingorunknownrequired

        success when the merge gate passes; missing when a required context has not reported; unknown while the required checks are (an unforced merge is refused).

      • requiredarray | nullrequired

        Null while unknown.

      • checks_unknownstring | nullrequired

        Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise.

      • statusesarray ofobjectrequired

        The latest status per context.

        8 properties
        • shastringrequired
        • contextstringrequired
        • statependingorsuccessorfailureorerrorrequired
        • created_atstringrequired
          format: date-time
        • target_urloptionalstring | null
        • descriptionoptionalstring | null
        • creatoroptionalstring

          The member who posted it (a login); app:<slug> for a status posted with a status token or by a CI integration; hook:<hook id> for a status token from a web hook with no app.

        • appoptionalstring | null

          The CI service that reported it (buildkite, github-actions, ...), stamped by Pando from a status token or a CI integration, never from the body or target_url. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows.

      • missingoptionalarray ofstring
Navigation

Type to search…

↑↓ navigate↵ selectEsc close