org.tangled.ci.triggerPipeline

tangled.org

Documentation

Trigger a pipeline at an explicit commit. Runs the named workflows, or every workflow defined in the repo when none are named.

main procedure

Trigger a pipeline at an explicit commit. Runs the named workflows, or every workflow defined in the repo when none are named.

Input

Encodingapplication/json
repo stringdid Required

Target repository DID. Auth is checked against this repo.

trigger union Required

Trigger metadata for this dispatch.

workflows array Optional

Workflow names to run. When not provided, every dispatchable workflow is run.

Output

Encodingapplication/json
pipeline string Required

Spindle-local id of the created pipeline

Errors

InvalidRequest Invalid request parameters
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Trigger a pipeline at an explicit commit. Runs the named workflows, or every workflow defined in the repo when none are named.",
  "errors": [
    {
      "description": "Invalid request parameters",
      "name": "InvalidRequest"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "repo": {
          "description": "Target repository DID. Auth is checked against this repo.",
          "format": "did",
          "type": "string"
        },
        "trigger": {
          "closed": false,
          "description": "Trigger metadata for this dispatch.",
          "refs": [
            "org.tangled.ci.trigger.manual",
            "org.tangled.event.pullRequest"
          ],
          "type": "union"
        },
        "workflows": {
          "description": "Workflow names to run. When not provided, every dispatchable workflow is run.",
          "items": {
            "description": "workflow name",
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "repo",
        "trigger"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "pipeline": {
          "description": "Spindle-local id of the created pipeline",
          "type": "string"
        }
      },
      "required": [
        "pipeline"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@