Presubmit.Runner (presubmit v0.2.2)

Copy Markdown View Source

Runs rules against change sets and collects the outcomes.

Summary

Functions

run(commit, rules, opts \\ [])

Runs every rule against the change set.

run_range(repo, range, rules, opts \\ [])

Runs every rule against each non-merge commit in range (any git rev-list range, oldest first).

Functions

run(commit, rules, opts \\ [])

@spec run(Presubmit.Commit.t(), [Presubmit.Rule.t()], keyword()) ::
  Presubmit.Runner.Report.t()

Runs every rule against the change set.

Rules run in a worker process, so a rule that does not finish within opts[:timeout] milliseconds (default 30 seconds) is stopped and reported as an Presubmit.RuleTimeoutError; the remaining rules run in a fresh worker.

run_range(repo, range, rules, opts \\ [])

@spec run_range(Path.t(), String.t(), [Presubmit.Rule.t()], keyword()) :: [
  Presubmit.Runner.Report.t()
]

Runs every rule against each non-merge commit in range (any git rev-list range, oldest first).