Skip to content

dependabit / manifest/src / getEffectiveMonitoringRules

Function: getEffectiveMonitoringRules()

ts
function getEffectiveMonitoringRules(config, dependencyUrl): {
  checkFrequency: "hourly" | "daily" | "weekly" | "monthly";
  enabled: boolean;
  ignoreChanges: boolean;
};

Defined in: packages/manifest/src/config.ts:85

Resolves the effective monitoring rules for a specific dependency URL by merging global config defaults with any per-URL override defined in config.dependencies.

Parameters

ParameterTypeDescription
config{ dependencies?: { issues?: { aiAgentAssignment?: { breaking?: string; enabled: boolean; major?: string; minor?: string; }; assignees: string[]; bodyTemplate?: string; labels: string[]; titleTemplate: string; }; monitoring?: { checkFrequency: "hourly" | "daily" | "weekly" | "monthly"; enabled: boolean; ignoreChanges: boolean; severityOverride?: "breaking" | "major" | "minor"; }; schedule?: { day?: | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"; interval: "hourly" | "daily" | "weekly" | "monthly"; time?: string; timezone: string; }; url: string; }[]; ignore?: { patterns?: string[]; types?: ( | "reference-implementation" | "schema" | "documentation" | "research-paper" | "api-example" | "other")[]; urls?: string[]; useGitExcludes: boolean; }; issues?: { aiAgentAssignment?: { breaking?: string; enabled: boolean; major?: string; minor?: string; }; assignees: string[]; bodyTemplate?: string; labels: string[]; titleTemplate: string; }; llm?: { maxTokens: number; model?: string; provider: "github-copilot" | "claude" | "openai" | "azure-openai"; temperature: number; }; monitoring?: { autoUpdate: boolean; enabled: boolean; falsePositiveThreshold: number; }; schedule: { day?: | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"; interval: "hourly" | "daily" | "weekly" | "monthly"; time?: string; timezone: string; }; version: "1"; }Root DependabitConfig object.
config.dependencies?{ issues?: { aiAgentAssignment?: { breaking?: string; enabled: boolean; major?: string; minor?: string; }; assignees: string[]; bodyTemplate?: string; labels: string[]; titleTemplate: string; }; monitoring?: { checkFrequency: "hourly" | "daily" | "weekly" | "monthly"; enabled: boolean; ignoreChanges: boolean; severityOverride?: "breaking" | "major" | "minor"; }; schedule?: { day?: | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"; interval: "hourly" | "daily" | "weekly" | "monthly"; time?: string; timezone: string; }; url: string; }[]-
config.ignore?{ patterns?: string[]; types?: ( | "reference-implementation" | "schema" | "documentation" | "research-paper" | "api-example" | "other")[]; urls?: string[]; useGitExcludes: boolean; }-
config.ignore.patterns?string[]-
config.ignore.types?( | "reference-implementation" | "schema" | "documentation" | "research-paper" | "api-example" | "other")[]-
config.ignore.urls?string[]-
config.ignore.useGitExcludesboolean-
config.issues?{ aiAgentAssignment?: { breaking?: string; enabled: boolean; major?: string; minor?: string; }; assignees: string[]; bodyTemplate?: string; labels: string[]; titleTemplate: string; }-
config.issues.aiAgentAssignment?{ breaking?: string; enabled: boolean; major?: string; minor?: string; }-
config.issues.aiAgentAssignment.breaking?string-
config.issues.aiAgentAssignment.enabledboolean-
config.issues.aiAgentAssignment.major?string-
config.issues.aiAgentAssignment.minor?string-
config.issues.assigneesstring[]-
config.issues.bodyTemplate?string-
config.issues.labelsstring[]-
config.issues.titleTemplatestring-
config.llm?{ maxTokens: number; model?: string; provider: "github-copilot" | "claude" | "openai" | "azure-openai"; temperature: number; }-
config.llm.maxTokensnumber-
config.llm.model?string-
config.llm.provider"github-copilot" | "claude" | "openai" | "azure-openai"-
config.llm.temperaturenumber-
config.monitoring?{ autoUpdate: boolean; enabled: boolean; falsePositiveThreshold: number; }-
config.monitoring.autoUpdateboolean-
config.monitoring.enabledboolean-
config.monitoring.falsePositiveThresholdnumber-
config.schedule{ day?: | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"; interval: "hourly" | "daily" | "weekly" | "monthly"; time?: string; timezone: string; }-
config.schedule.day?| "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday"-
config.schedule.interval"hourly" | "daily" | "weekly" | "monthly"-
config.schedule.time?string-
config.schedule.timezonestring-
config.version"1"-
dependencyUrlstringThe exact URL of the dependency to look up.

Returns

ts
{
  checkFrequency: "hourly" | "daily" | "weekly" | "monthly";
  enabled: boolean;
  ignoreChanges: boolean;
}

Resolved enabled, checkFrequency, and ignoreChanges values.

NameTypeDefined in
checkFrequency"hourly" | "daily" | "weekly" | "monthly"packages/manifest/src/config.ts:90
enabledbooleanpackages/manifest/src/config.ts:89
ignoreChangesbooleanpackages/manifest/src/config.ts:91

Remarks

Override matching is performed by exact URL equality. A trailing slash or query parameter difference between the stored URL and the override URL will cause the override to be silently ignored.

Released under the MIT License.