Skip to content

dependabit / manifest/src / DependabitConfigSchema

Variable: DependabitConfigSchema

ts
const DependabitConfigSchema: ZodObject<{
  dependencies: ZodOptional<ZodArray<ZodObject<{
     issues: ZodOptional<ZodObject<{
        aiAgentAssignment: ZodOptional<ZodObject<..., ...>>;
        assignees: ZodDefault<ZodArray<...>>;
        bodyTemplate: ZodOptional<ZodString>;
        labels: ZodDefault<ZodArray<...>>;
        titleTemplate: ZodDefault<ZodString>;
     }, $strip>>;
     monitoring: ZodOptional<ZodObject<{
        checkFrequency: ZodDefault<ZodEnum<...>>;
        enabled: ZodDefault<ZodBoolean>;
        ignoreChanges: ZodDefault<ZodBoolean>;
        severityOverride: ZodOptional<ZodEnum<...>>;
     }, $strip>>;
     schedule: ZodOptional<ZodObject<{
        day: ZodOptional<ZodEnum<...>>;
        interval: ZodEnum<{
           daily: ...;
           hourly: ...;
           monthly: ...;
           weekly: ...;
        }>;
        time: ZodOptional<ZodString>;
        timezone: ZodDefault<ZodString>;
     }, $strip>>;
     url: ZodString;
  }, $strip>>>;
  ignore: ZodOptional<ZodObject<{
     patterns: ZodOptional<ZodArray<ZodString>>;
     types: ZodOptional<ZodArray<ZodEnum<{
        api-example: "api-example";
        documentation: "documentation";
        other: "other";
        reference-implementation: "reference-implementation";
        research-paper: "research-paper";
        schema: "schema";
     }>>>;
     urls: ZodOptional<ZodArray<ZodString>>;
     useGitExcludes: ZodDefault<ZodBoolean>;
  }, $strip>>;
  issues: ZodOptional<ZodObject<{
     aiAgentAssignment: ZodOptional<ZodObject<{
        breaking: ZodOptional<ZodString>;
        enabled: ZodDefault<ZodBoolean>;
        major: ZodOptional<ZodString>;
        minor: ZodOptional<ZodString>;
     }, $strip>>;
     assignees: ZodDefault<ZodArray<ZodString>>;
     bodyTemplate: ZodOptional<ZodString>;
     labels: ZodDefault<ZodArray<ZodString>>;
     titleTemplate: ZodDefault<ZodString>;
  }, $strip>>;
  llm: ZodOptional<ZodObject<{
     maxTokens: ZodDefault<ZodNumber>;
     model: ZodOptional<ZodString>;
     provider: ZodDefault<ZodEnum<{
        azure-openai: "azure-openai";
        claude: "claude";
        github-copilot: "github-copilot";
        openai: "openai";
     }>>;
     temperature: ZodDefault<ZodNumber>;
  }, $strip>>;
  monitoring: ZodOptional<ZodObject<{
     autoUpdate: ZodDefault<ZodBoolean>;
     enabled: ZodDefault<ZodBoolean>;
     falsePositiveThreshold: ZodDefault<ZodNumber>;
  }, $strip>>;
  schedule: ZodDefault<ZodObject<{
     day: ZodOptional<ZodEnum<{
        friday: "friday";
        monday: "monday";
        saturday: "saturday";
        sunday: "sunday";
        thursday: "thursday";
        tuesday: "tuesday";
        wednesday: "wednesday";
     }>>;
     interval: ZodEnum<{
        daily: "daily";
        hourly: "hourly";
        monthly: "monthly";
        weekly: "weekly";
     }>;
     time: ZodOptional<ZodString>;
     timezone: ZodDefault<ZodString>;
  }, $strip>>;
  version: ZodLiteral<"1">;
}, $strip>;

Defined in: packages/manifest/src/schema.ts:218

Zod schema for the top-level .dependabit.yml / .dependabit.json configuration file.

Remarks

Parse with validateConfig or safeValidateConfig (from @dependabit/manifest) rather than calling .parse() directly so that validation errors are wrapped in ValidationError with formatted messages.

See

DependabitConfig for the TypeScript type.

Released under the MIT License.