Skip to content
Pando

Make a release (published at once unless draft)

Its commit: the tag's when the tag exists, else target (a commit on main, or main), else main's head. A commit not on main is refused (422 not_on_main). Unless draft, it is published at once by the publish rule, and refused (412 checks_not_green) before anything is made. generate_notes appends notes written from the merges since the last published release. The tag latest is refused.

POST
https://app.gitpando.com/v1/monorepos/{owner}/{monorepo}/repos/{repo}/releases
View as Markdown

Authorisation

  • credentialoptionalHTTP
  • sessionoptionalAPI key in cookie

Path parameters

  • ownerstringrequired

    The monorepo's owner, a namespace (a person's login or an organization). Matched without case.

    pattern: ^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$
  • monorepostringrequired

    The monorepo's name within its owner (or an old name). Matched without case.

    pattern: ^[a-z0-9](?:[a-z0-9._]|-(?!-)){0,38}$
  • repostringrequired

    The repo's name (projects-web).

Request bodyJSONrequired

  • tagstringrequired
  • targetoptionalstring
  • titleoptionalstring

    At most 200 characters; default: the tag.

  • notesoptionalstring
  • generate_notesoptionalboolean
  • draftoptionalboolean
    Default: false
  • forceoptionalboolean
    Default: false

Returns

201

Made

JSON
  • repostringrequired
  • tagstringrequired
  • shastringrequired

    Its commit

  • titlestringrequired
  • notesstringrequired

    Markdown

  • draftbooleanrequired
  • forcedbooleanrequired

    Published past red or missing required checks.

  • created_bystringrequired
  • created_atstringrequired
    format: date-time
  • updated_atstringrequired
    format: date-time
  • published_bystring | nullrequired
  • published_atstring | nullrequired
    format: date-time
  • filesarray ofobjectrequired
    6 properties
    • namestringrequired
    • sizeintegerrequired
    • sha256stringrequired
    • content_typestringrequired
    • uploaded_bystringrequired
    • uploaded_atstringrequired
      format: date-time
  • checksoptionalobject

    Its commit's checks; on getRelease only.

    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