Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.41 KB

README.textile

File metadata and controls

33 lines (20 loc) · 1.41 KB

A post-receive webhook for GitHub

Processes JSON requests generated by GitHub in response to commits. For information on
how to configure post-receive hooks, please read this article

The software is written in C# and was developed and tested on Mono, although it should work without any
modifications on .NET/Windows as well. If you find any bugs, please report the issues here

More documentation is available in the CaptainHook Wiki

Features

Templates

CaptainHook uses a simple templating markup in which there is one main template file (mail.txt or COMMIT_SOURCE_ID.mail.txt) which can
reference several other template files, corresponding to collection items. For instance, given a list of Commit classes, the following code

@Commits@

placed in main.txt refers to the Push.Commits collection (an instance of List <Commit>) and causes the macro processor to determine
the collection element type (Commit) and attempt to look up a commit.txt template file to be used with each element of the collection.

Default mail.txt and commit.txt files are shipped.

Multiple commit sources

Each commit source is identified with a unique ID and defines its own set of mail addresses to send mails to.

License

MIT X11, full text in the LICENSE file