Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xpaw/github-webhook

🐱 Validates and processes GitHub's webhooks
https://github.com/xpaw/github-webhook

github github-webhooks irc parsing php

Last synced: 3 months ago
JSON representation

🐱 Validates and processes GitHub's webhooks

Awesome Lists containing this project

README 

        
This script acts as a web hook for [GitHub](https://github.com/) events, processes them,

and returns messages which can be sent out to an IRC channel or a Discord webhook,

depending on the converter used.



See `examples/discord.php` for a basic application that sends webhooks to Discord.  

See `examples/irker.php` for a basic application that sends messages to IRC.  



## GitHubWebHook

`GitHubWebHook.php` accepts, processes and validates an event,

it also can make sure that the event came from a GitHub server.



Functions in this class are:



#### ProcessRequest()

Accepts an event, throws `Exception` on error.



#### GetEventType()

Returns event type.

See https://developer.github.com/webhooks/#events for a list of events.



#### GetPayload()

Returns decoded JSON payload as an object.



#### GetFullRepositoryName()

Returns full name of the repository for which an event was sent for.



#### ValidateHubSignature( $SecretKey )

Retuns true if HMAC hex digest of the payload matches GitHub's, false otherwise.



## IrcConverter

`IrcConverter.php` accepts input from previous script and outputs

a colored string which can be sent to IRC.



#### __construct( $EventType, $Payload )

`IrcConverter` constructor takes 3 paramaters (last one is optional).

All you need to do is pass data after parsing the message with `GitHubWebHook`

like so: `new IrcConverter( $Hook->GetEventType(), $Hook->GetPayload() );`



URL shortener paramater takes a function, and that function should accept

a single string argument containing an url. If your function fails to

shorten an url or do anything with it, your function must return the

original url back.



#### GetMessage()

After calling the constructor, using this function will return

a string which can be sent to an IRC server.



Throws `NotImplementedException` when you pass an event that

is not parsed anyhow, and throws `IgnoredEventException` for

`fork`, `watch` and `status` events which are ignored by design.



## Events [\[ref\]](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads)



Track changes to GitHub webhook payloads documentation here: https://github.com/github/docs/commits/main/data/reusables/webhooks



### Supported events



- commit_comment

- delete

- discussion

- discussion_comment

- gollum

- issue_comment

- issues

- member

- milestone

- package

- ping

- project

- public

- pull_request

- pull_request_review

- pull_request_review_comment

- push

- release

- repository

- repository_vulnerability_alert



### Not yet supported events



- check_run

- check_suite

- code_scanning_alert

- deploy_key

- deployment

- deployment_status

- label

- membership

- meta

- org_block

- organization

- page_build

- project_card

- project_column

- repository_import

- sponsorship

- team

- team_add



### Events ignored by design



- create - Formatted from push event instead

- fork

- star

- status

- watch



Additionally, events like labelling or assigning an issue are also ignored.

Push event ignores branch deletions (use delete event instead).



### Events that can not be supported



- content_reference

- github_app_authorization

- installation

- installation_repositories

- marketplace_purchase

- repository_dispatch

- security_advisory

- workflow_dispatch

- workflow_run



## License

[MIT](LICENSE)