package crs

You can search for identifiers within the package.

in-package search v0.2.0

A tool for managing code review comments embedded in source code

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (2)

Authors

M

Mathieu Barbin

Maintainers

M

Mathieu Barbin <opensource@mbarbin.org>

Sources

crs-0.0.20250705.tbz

sha256=e9f9f5ec5aea9658ed640aaa06f887985bb6870adcf7555ebf6d48bb741e4793

sha512=901ac1caae6c4103a320b4a3a177ca3aa0583ad533c54e7740aba6652ccdbd6311d07ab4b73e3ba750beed24f85479b5e1b0e94504ecfd0c59bd49cdabebc369

doc/crs.crs-cli/Crs_cli/Private/Annotation/index.html

Module `Private.Annotation`Source

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

Source

val 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

Source

val 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

On This Page

Utils
Getters