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-project

Dependency

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

Authors

M

Mathieu Barbin

Maintainers

M

Mathieu Barbin <opensource@mbarbin.org>

Sources

crs-0.0.20250914.tbz

sha256=dad0c46a83ef40da150d8b840b01c66af3b979dfa7c3e17c3edef38aa84b804f

sha512=d7a8b2a34f4a3ddda0eaaa3e4248ec2870f944a5d64782bd73b031637b01e94a378d7534b1c02da739f32343b342ed8e8bf491e6442a3bd7b0e748bd61c58770

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_parser.Private.Github_annotation.t

Sourceval to_reviewdog_diagnostic : t -> Reviewdog.Diagnostic.t

On This Page

Utils
Getters