0.0
No commit activity in last 3 years
No release in over 3 years
GitHub payload event helper
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

< 2.0, >= 0.3.10
 Project Readme

Jackal Github

Processes incoming payloads from github.

Usage

Configure incoming source using the :http_paths source:

...
"sources": {
  "input": {
    "type": "http_paths",
    "args": {
      "port": 9090,
      "path": "/github",
      "method": "post"
    }
  }
}
...

Configuration

The name provided for the payload defaults to "github". This can be overridden in the configuration using the names map, which allows names to be provided on a per-event basis:

...
"config": {
  "names": {
    "push": PUSH_NAME,
    "create": CREATE_NAME
  }
}
...

Payload

The payload generated will contain the contents fo the github payload, any query parameters provided, and the headers. It will also add in an event key to designate what type of event was received.

...
"data": {
  "github": {
    "event": "X_GITHUB_EVENT",
    "query": QUERY_PARAMS,
    "headers": HTTP_HEADERS,
    GITHUB_PAYLOAD
  }
}
...

Formatters

  • Jackal::Github::Formatter::CodeFetcher Formats payload for code fetcher

Info