Skip to content

CommitPage

Fields

  • commitobjectrequired
    8 properties
    • shastringrequired
    • parentsarray ofstringrequired
    • titlestringrequired

      The message's first line.

    • messagestringrequired

      The full message, at most 4,096 characters.

    • authorobjectrequired
      3 properties
      • nameoptionalstring | null
      • emailoptionalstring | null
      • dateoptionalstring | null
        format: date-time
    • committerobjectrequired
      3 properties
      • nameoptionalstring | null
      • emailoptionalstring | null
      • dateoptionalstring | null
        format: date-time
    • trailersobjectrequired
      3 properties
      • agentstring | nullrequired
      • worktreestring | nullrequired
      • machinestring | nullrequired
    • co_authorsoptionalarray ofobject

      Co-authored-by: Name <email> lines from the message's trailers (its last paragraph), each once, as git and GitHub read them.

      2 properties
      • namestringrequired
      • emailstring | nullrequired
  • author_personobject | nullrequired
    2 properties
    • loginoptionalstring
    • picture_urloptionalstring | null
  • branchCommitBranchornullrequired
    2 variants

    One of the following:

    • 4 properties
      • namestringrequired
      • titlestring | nullrequired
      • stateopenormergedordeletedrequired
      • merge_commitstring | nullrequired

        Its merge into the default branch

    • null
  • merge_ofCommitBranchornullrequired
    2 variants

    One of the following:

    • 4 properties
      • namestringrequired
      • titlestring | nullrequired
      • stateopenormergedordeletedrequired
      • merge_commitstring | nullrequired

        Its merge into the default branch

    • null
  • checksobjectrequired

    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