org.tangled.ci.defs

tangled.org

Documentation

externalSource object

No description available.

Properties

name string Optional

human-readable name of external source

View raw schema 
{
  "properties": {
    "link": {
      "format": "uri",
      "type": "string"
    },
    "name": {
      "description": "human-readable name of external source",
      "type": "string"
    }
  },
  "required": [
    "link"
  ],
  "type": "object"
}
fileSource object

No description available.

Properties

commit string Required

No description available.

maxLength: 128 bytesminLength: 40 bytes
lines ref #lineRange Optional

No description available.

path string Required

No description available.

minLength: 1 bytes
repo string did Required

A decentralized identifier (DID).

View raw schema 
{
  "properties": {
    "commit": {
      "maxLength": 128,
      "minLength": 40,
      "type": "string"
    },
    "lines": {
      "ref": "#lineRange",
      "type": "ref"
    },
    "path": {
      "minLength": 1,
      "type": "string"
    },
    "repo": {
      "format": "did",
      "type": "string"
    }
  },
  "required": [
    "repo",
    "commit",
    "path"
  ],
  "type": "object"
}
lineRange object

No description available.

Properties

end integer Required

No description available.

minimum: 1
start integer Required

No description available.

minimum: 1
View raw schema 
{
  "properties": {
    "end": {
      "minimum": 1,
      "type": "integer"
    },
    "start": {
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "start",
    "end"
  ],
  "type": "object"
}
pipeline object

A CI pipeline. Record-like, but owned by the spindle rather than a PDS.

Properties

commit string Required

Commit Id this pipeline is running on

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

id string record-key Required

Spindle-local pipeline id

repo string did Required

Repository DID

sourceRepo string did Optional

Repository DID that the commit was checked out from, if different from repo (e.g. a fork for a fork-based pull request)

workflows array of ref#workflowRun Required

Triggered workflows

maxLength: 50 itemsminLength: 1 items
View raw schema 
{
  "description": "A CI pipeline. Record-like, but owned by the spindle rather than a PDS.",
  "properties": {
    "commit": {
      "description": "Commit Id this pipeline is running on",
      "type": "string"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "id": {
      "description": "Spindle-local pipeline id",
      "format": "record-key",
      "type": "string"
    },
    "repo": {
      "description": "Repository DID",
      "format": "did",
      "type": "string"
    },
    "sourceRepo": {
      "description": "Repository DID that the commit was checked out from, if different from repo (e.g. a fork for a fork-based pull request)",
      "format": "did",
      "type": "string"
    },
    "trigger": {
      "closed": false,
      "description": "Trigger event that triggered this pipeline.",
      "refs": [
        "org.tangled.event.push",
        "org.tangled.event.pullRequest",
        "org.tangled.ci.trigger.manual",
        "org.tangled.ci.trigger.schedule"
      ],
      "type": "union"
    },
    "workflows": {
      "description": "Triggered workflows",
      "items": {
        "ref": "#workflowRun",
        "type": "ref"
      },
      "maxLength": 50,
      "minLength": 1,
      "type": "array"
    }
  },
  "required": [
    "id",
    "repo",
    "trigger",
    "commit",
    "workflows"
  ],
  "type": "object"
}
workflow object

A workflow definition

Properties

hash string Optional

Fingerprint of the workflow definition as resolved by the spindle.

id string Required

No description available.

maxLength: 128 bytesminLength: 1 bytes
name string Optional

Human-readable name of the workflow

maxLength: 128 bytesminLength: 1 bytes
triggers array of string Required

Event types that triggers this workflow.

View raw schema 
{
  "description": "A workflow definition",
  "properties": {
    "hash": {
      "description": "Fingerprint of the workflow definition as resolved by the spindle.",
      "type": "string"
    },
    "id": {
      "maxLength": 128,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "description": "Human-readable name of the workflow",
      "maxLength": 128,
      "minLength": 1,
      "type": "string"
    },
    "source": {
      "refs": [
        "#fileSource",
        "#externalSource"
      ],
      "type": "union"
    },
    "triggers": {
      "description": "Event types that triggers this workflow.",
      "items": {
        "knownValues": [
          "org.tangled.event.push",
          "org.tangled.event.pullRequest",
          "org.tangled.ci.trigger.manual",
          "org.tangled.ci.trigger.schedule"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "source",
    "triggers"
  ],
  "type": "object"
}
workflowRun object

No description available.

Properties

definition ref #workflow Required

Workflow definition where this workflow run is originated from.

error string Optional

No description available.

finishedAt string datetime Optional

An RFC 3339 formatted timestamp.

id string Required

Pipeline-local workflow id, usually same as name.

maxLength: 128 bytesminLength: 1 bytes
name string Optional

Human-readable name of the workflow

maxLength: 128 bytes
startedAt string datetime Optional

An RFC 3339 formatted timestamp.

status string Required

Workflow status

View raw schema 
{
  "properties": {
    "definition": {
      "description": "Workflow definition where this workflow run is originated from.",
      "ref": "#workflow",
      "type": "ref"
    },
    "error": {
      "type": "string"
    },
    "finishedAt": {
      "format": "datetime",
      "type": "string"
    },
    "id": {
      "description": "Pipeline-local workflow id, usually same as name.",
      "maxLength": 128,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "description": "Human-readable name of the workflow",
      "maxLength": 128,
      "type": "string"
    },
    "startedAt": {
      "format": "datetime",
      "type": "string"
    },
    "status": {
      "description": "Workflow status",
      "enum": [
        "pending",
        "blocked",
        "running",
        "failed",
        "timeout",
        "cancelled",
        "success"
      ],
      "type": "string"
    }
  },
  "required": [
    "definition",
    "id",
    "status"
  ],
  "type": "object"
}

Lexicon Garden

@