Projects
Git Connections

Report the project's source-of-truth state

Changed on

Volcano stores the source of the functions and frontend it runs for a project. This reports whether that source has been written to the connected repository, and whether the repository has taken over as the project's source of truth.

mode is platform, git_exporting, git_pending, or git. Export enters git_exporting before reading stored source. GitHub's signed push event confirms that the initial commit reached the production branch. That push or a newer production push changes the mode to git_pending when it starts a deployment. exported_at records that transition.

A successful Git run completes the transition when it matches the recorded repository, production branch, and root directory and actually dispatches every recorded resource. Ordinary production-branch pushes deploy without changing a platform-managed project's source ownership.

get/projects/{id}/source-export

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/source-export
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

Response

The project's source-of-truth state

mode'platform' | 'git_exporting' | 'git_pending' | 'git' required
transition_started_atstring date-time nullable required

When source export started, cleared if an incomplete transition is canceled.

exported_atstring date-time nullable required

When the initial export push entered deployment, or when a transition was canceled after its commit was reserved. Once set, the one-time export is consumed.

handed_over_atstring date-time nullable required

When a complete production-branch deployment first proved the repository could drive the project, null until then. Once set, the repository is the project's source of truth.

Changes

    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

    • ▲

      added the new path request parameter id

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status