overlane repo protection

Lists the protection rules: pattern, approvals, required checks and allowed merge methods.

Usage

overlane repo protection repo

Arguments

Argument	Required	Description
`repo`	yes	The repository name or ID

Examples

overlane repo protection app

Behavior

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

Result

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

{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string"
    },
    "protections": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "tenant identifier"
          },
          "repoId": {
            "type": "string",
            "pattern": "^repo_[A-Za-z0-9]{6,40}$"
          },
          "pattern": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "requiredChecks": {
            "maxItems": 50,
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            }
          },
          "requiredApprovals": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10
          },
          "allowForcePush": {
            "type": "boolean",
            "const": false
          },
          "allowedMergeMethods": {
            "minItems": 1,
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "merge",
                "squash",
                "rebase"
              ]
            }
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          }
        },
        "required": [
          "tenantId",
          "repoId",
          "pattern",
          "requiredChecks",
          "requiredApprovals",
          "allowForcePush",
          "allowedMergeMethods",
          "updatedAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "tenantId",
    "protections"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.