Current_github (u.88c5fd379afd0eecdb14f6554af41b1b.current_github.0.7.3.doc.current_github.Current

Source

val webhook : 
  engine:Current.Engine.t ->
  get_job_ids:(owner:string -> name:string -> hash:string -> string list) ->
  webhook_secret:string ->
  Current_web.Resource.t

GitHub webhook endpoint. This MUST be added to Current_web.routes so that we get notified of events. This webhook handles the events:

installation_repositories
installation
pull_request
push
create
check_run
check_suite

Webhook payloads are validated against webhook_secret.

See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks

Note that the endpoint is supplied with a callback `get_job_ids.` This is used to determine what job_ids correspond to a commit. The checks API specifies the repository and the commit (that the action is being requested against) - this callback is used to determine what jobs to apply the action to.

Permissions are managed by the checks API so that re-runs can only be requested by anyone with write permission to a repository.

Sourcemodule Repo_id : sig ... end

Identifier for a repository hosted on GitHub.

Sourcemodule Api : sig ... end

Access to the GitHub API.

Sourcemodule Installation : sig ... end

Installation of a GitHub application.

Sourcemodule App : sig ... end

A GitHub Application.

Sourcemodule Auth : sig ... end

Use GitHub to authenticate users.