package crs

  1. Overview
  2. Docs
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

  1. M
    Mathieu Barbin

Maintainers

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

Sources

crs-0.0.20250914.tbz
sha256=dad0c46a83ef40da150d8b840b01c66af3b979dfa7c3e17c3edef38aa84b804f
sha512=d7a8b2a34f4a3ddda0eaaa3e4248ec2870f944a5d64782bd73b031637b01e94a378d7534b1c02da739f32343b342ed8e8bf491e6442a3bd7b0e748bd61c58770

doc/crs.crs-parser/Crs_parser/Private/User_message/index.html

Module Private.User_messageSource

A helper module to create user messages that may be highlighted by GitHub Annotations for accrued discoverability.

For use in GitHub workflows.

Sourceval warning : ?loc:Loc.t -> emit_github_annotations:Base.bool -> ?hints:Pp_tty.t Base.list -> Pp_tty.t Base.list -> Base.unit

Emit a warning with Err.warning with the supplied messages. 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.

Motivation: When running in CI/CD environments, warnings printed to stderr can easily be missed among other output. GitHub workflow annotations provide a way to surface these warnings prominently in the GitHub UI, appearing both in the workflow run summary and as inline annotations in pull requests. This significantly improves the discoverability of warnings that might otherwise go unnoticed, helping developers address issues before merging code.

The optional hints parameter provides additional context or suggestions for resolving the warning. When GitHub annotations are enabled, hints are included in the annotation message with a "Hints: " prefix.

Sourceval error : ?loc:Loc.t -> emit_github_annotations:Base.bool -> ?hints:Pp_tty.t Base.list -> Pp_tty.t Base.list -> Base.unit

Same as warning but with the severity of an error. This results in making the overall exit code of the application a non-zero code.