package crs

You can search for identifiers within the package.

in-package search v0.2.0

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

M

Mathieu Barbin

Maintainers

M

Mathieu Barbin <opensource@mbarbin.org>

Sources

crs-0.0.20260307.tbz

sha256=77f77c61e908a6716fa876f5648f662ffaf7e24be4a7889fd6b53121592311bb

sha512=5fc6252650571c4127ebb1e61fecf78c5d4ce35e2832dff47125cda1448e07ea6d4da5e3a9a28643e3491d3594b0ee8857214241f98bd0296ada2c35ea8daa4b

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

Module `Std.User_message`Source

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

For use in GitHub workflows.

Source

val warning : 
  ?loc:Loc.t ->
  emit_github_annotations:bool ->
  ?hints:Pplumbing_pp_tty.Pp_tty.t list ->
  Pplumbing_pp_tty.Pp_tty.t list ->
  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.

Source

val error : 
  ?loc:Loc.t ->
  emit_github_annotations:bool ->
  ?hints:Pplumbing_pp_tty.Pp_tty.t list ->
  Pplumbing_pp_tty.Pp_tty.t list ->
  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.