package crs

  1. Overview
  2. Docs
A tool for managing inline review comments embedded in source code

Install 

dune-project
 Dependency

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

Authors

  1. M
    Mathieu Barbin

Maintainers

  1. M
    Mathieu Barbin <opensource@mbarbin.org>

Sources

crs-0.0.20260307.tbz
sha256=77f77c61e908a6716fa876f5648f662ffaf7e24be4a7889fd6b53121592311bb
sha512=5fc6252650571c4127ebb1e61fecf78c5d4ce35e2832dff47125cda1448e07ea6d4da5e3a9a28643e3491d3594b0ee8857214241f98bd0296ada2c35ea8daa4b

doc/crs.crs-cli/Crs_cli/Private/Std/Review_mode/index.html

Module Std.Review_modeSource

Review_mode.t describes the context in which the CR assignment and annotation logic is executed. This is not strictly tied to the CI event that triggered the workflow, but rather to the review/assignment semantics:

  • Pull_request: The workflow is running in the context of a pull request, and the author is the user who opened the PR. We are in the process of requiring the base revision of the PR, but currently are supporting older workflow that do not supply it. We expect the base to be supplied by the most up to date clients.
  • Revision: The workflow is running in the vcs tree checked out at a specific revision and there is no specific PR.

There exists a natural mapping between the event kinds that are triggering GitHub Actions Workflows and this review mode. Namely:

  • github.event_name == 'pull_request': This is a pull request event and maps to the Pull_request review mode.
  • github.event_name == 'push': Jobs triggered on a 'push' event are best run in Revision review mode. In this mode, workflows run in the tree checked out at a specific revision, but the context is not tied to a particular pull request.
Sourcetype t =
  1. | Pull_request of {
    1. author : Cr_comment.Std.User_handle.t;
    2. base : Volgo.Vcs.Rev.t option;
    }
  2. | Revision
Sourceval equal : t -> t -> bool
Sourceval to_dyn : t -> Crs_stdlib.Dyn.t
Sourceval arg : emit_github_annotations:bool -> t Cmdlang.Command.Arg.t

Build a t from parsing arguments in the command line. For convenience and help users discover warnings during CI runs, this can optionally include CI warnings on stderr for GitHub, using workflow annotations. To activate, supply emit_github_annotations:true.