RuleContext
Shared context provided to rules when they run on an entity.
Properties
Section titled “Properties”locator
Section titled “locator”locator:
RepositoryLocator
Repository location on GitHub.
octokit
Section titled “octokit”octokit:
Octokit&object&paginateGraphQLInterface&Api&object
Octokit instance that can send GitHub API calls.
Type Declaration
Section titled “Type Declaration”paginate
Section titled “paginate”paginate:
PaginateInterface
Type Declaration
Section titled “Type Declaration”retry:
object
retry.retryRequest()
Section titled “retry.retryRequest()”retryRequest: (
error,retries,retryAfter) =>RequestError
Parameters
Section titled “Parameters”RequestError
retries
Section titled “retries”number
retryAfter
Section titled “retryAfter”number
Returns
Section titled “Returns”RequestError
report
Section titled “report”report:
RuleReporter
Registers a new violation.