runOctoGuideRules

runOctoGuideRules(options): Promise<RunOctoGuideRulesResult>

Runs OctoGuide’s rules to generate a list of reports for a GitHub entity. The entity can be provided as either a URL string (which will be fetched from the GitHub API) or pre-existing entity data.

Takes in a single parameter of type RunOctoGuideRulesOptions. Returns a RunOctoGuideRulesResult.

Parameters

options

RunOctoGuideRulesOptions

Configuration object

Returns

Promise<RunOctoGuideRulesResult>

Promise resolving to results with actor, entity data, and rule reports

Example

import { runOctoGuideRules } from "octoguide";

const { reports } = await runOctoGuideRules({
  entity: "https://github.com/OctoGuide/bot/issues/19",
});

console.log("Received reports:", reports);