No release in over 3 years
Low commit activity in last 3 years
A simple runner for Pronto that adds pre-defined comments based on which files have changed.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.9
~> 4.7.3
>= 12.3.3
>= 0

Runtime

>= 0.9.5, < 0.12.0
 Project Readme

Pronto Commentator Circle CI

Pronto Commentator a very simple runner for Pronto that outputs arbitrary comments based on filename matching. It's good for tagging specific people to review specific kinds of changes (for instance, tagging your security team if auth-related files change), and probably other things as well.

Configuration

The main configuration file should be located at .commentator/config.yml in your repo root. Pronto Commentator won't do anything unless the config file is present. The configuration is pretty simple: it needs a root files key, followed by associations of filename patterns to message file names. Here's an example:

files:
  app/lib/auth*.rb:
    ping_bob.md
  "doc/chapters/[1-3].txt":
    ping_real_writers.md

The message file names should point to files in the .commentator directory. For example, .commentator/ping_bob.md could look something like this:

@bob looks like someone's trying to change the auth logic again, better take a look!

(Files don't have to be Markdown, but if you're using Github it's kinda nice).

File name matching uses Glob syntax.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rainforestapp/pronto-commentator.