overlane ci validate | Overlane Docs

Parses .overlane/ci.yml (or –file) with the parser the service runs before every run, offline (with –remote the service parses it and answers). Errors are printed as path:line: message and the command exits 2; a valid file lists its jobs. Run it before pushing a change to the pipeline.

Usage

overlane ci validate [--file PATH] [--remote]

Flags

Flag	Type	Required	Default	Description
`--file`	string	no		The pipeline file (default: .overlane/ci.yml)
`--remote`	boolean	no		Send the file to the service and show its answer, to confirm the service reads it the way this command does

Examples

overlane ci validate
overlane ci validate --file ci/test.yml --json
overlane ci validate --remote

Behavior

Effect: read (changes nothing).
Needs credentials: no. Uses the network: no.
Supports --dry-run: no. Accepts --force: no.
Machine-readable description: overlane schema ci validate.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "file": {
      "type": "string"
    },
    "jobs": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "issues": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "line": {
            "type": "number"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "line",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "ok",
    "file",
    "jobs",
    "issues"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.