package crs

  1. Overview
  2. Docs
On This Page
  1. Utils
  2. Getters
package crs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Private.AnnotationSource

A type to hold information about a CR that is assigned in the ci event (pull request or push to ongoing branch).

This is used by workflow that integrate with platforms or tools supporting annotations, such as GitHub Annotations, and Reviewdog Diagnostics.

Sourcemodule Severity : sig ... end
Sourcetype t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval of_cr : cr:Cr_comment.t -> config:Crs_cli__.Config.t -> review_mode:Crs_cli__.Review_mode.t -> with_user_mentions:Base.bool -> t Base.option

When with_user_mentions is true, we prefix user names by '@' in annotations messages. See also write_username.

Utils

Sourceval write_username : user:Volgo_base.Vcs.User_handle.t -> with_user_mention:Base.bool -> Base.string

When with_user_mention is true we use the syntax '@user' in the annotation message to trigger a notification in the environment that will end up rendering this string. This doesn't always work, even when this is the correct syntax. For example, mentioning a user with '@' in a GitHub Annotations Panels does nothing.

Getters

Sourceval message : t -> Base.string
Sourceval severity : t -> Severity.t
Sourceval assignee : t -> Crs_cli__.Assignee.t
Sourceval with_user_mention : t -> Base.bool

Export to supported consumers / backend.

Sourceval to_github_annotation : t -> Crs_cli__.Github_annotation.t
Sourceval to_reviewdog_diagnostic : t -> Reviewdog.Diagnostic.t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct