Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions hooks/Readme.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
# Uncle Archie Continuous Integration Hooks

This directory contains scripts that are continous integration
hooks for Uncle Archie. Each file defines a `process_payload()`
that is imported by `../process_payload.py`.
This is the `hooks/` directory, which contains all the hooks
that are run by Uncle Archie to process webhooks.

Every time a webhook is received by Uncle Archie, it calls each
function with the webhook. Each hook script must use the payload
and meta-info provided to it to determine when it should run.
Each time an incoming webhook is received, Uncle Archie creates
one and only one instance of each hook, and is agnostic to the
details of each test.

## TODO
A singleton + factory method is implemented to return one
instance of each hook. This is called by the `process_payload.py`
script (one directory up), which is called by the flask webhook
server.

These hook functions follow certain templates and borrow certain
portions of code heavily from one another. These can be integrated
into objects that define methods to simplify the rote work and
make things re-usable and easier to set up.

Loading