PHPackages mecodeninja/githubwebhooks - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. mecodeninja/githubwebhooks ActiveLibrary[API Development](/categories/api) mecodeninja/githubwebhooks ========================== Provides a listener for GitHub Webhooks, runs business logic, creates a Status(es) in GitHub based on the results of the business logic. 1.2.1(5y ago)032MITPHPPHP >=5.0 Since Aug 16Pushed 4y ago1 watchersCompare [ Source](https://github.com/willwright/GitHubWebhooks)[ Packagist](https://packagist.org/packages/mecodeninja/githubwebhooks)[ RSS](/packages/mecodeninja-githubwebhooks/feed)WikiDiscussions master Synced 2mo ago READMEChangelog (6)DependenciesVersions (9)Used By (0) GitHubWebhooks ============== [](#githubwebhooks) Laravel Package that listens to GitHub webhook events and responds by creating Statuses in GitHub Laravel 5.6 ----------- [](#laravel-56) Tag 1.0+ is intended for use with Laravel 5.6 ``` composer require mecodeninja/githubwebhooks:^1.0 ``` Installation ------------ [](#installation) Install Package via Composer ``` composer require mecodeninja/githubwebhooks:^1.0 ``` Publish the Package Config ``` php artisan vendor:publish --provider="MeCodeNinja\GitHubWebhooks\GitHubWebhooksServiceProvider" ``` Configure the Checks to be performed on your repository by editing `%storage%/app/githubwebhooks-config.yaml` ``` nano storage/app/githubwebhooks-config.yaml ``` Set `name` to your github repository ``` repositories: - name: willwright/githubwebhooks token: %mytoken% checks: BranchCheck: branches: [origin/develop] PathCheck: paths: [/^vendor\//] ``` The `name` of the repository must match the `repo.full_name` in the payload sent by the GitHub Webhook in order to activate the Check(s). Set `token` to a Personal access token which was generated by you in GitHub. See: Token needs: repo (If your Repository is Private) repo > public\_repo (If your Repository is Public) > **Warning** > > Do **not** commit `githubwebhooks-config.yaml` to your SVN. It contains sensative information Repositories ------------ [](#repositories) As many repository items can be added to the Repositories sequence as is desired. The `repositories` sequence will be queried to build a set of Repositories which the `PullRequest` matches. Either the name must match exactly OR a wildcard can be used. Example: Given `PullRequest.repo.full_name` = "willwright/githubwebhooks". `respository.name` = "willwright/githubwebhooks" will match `respository.name` = "\*" will match `respository.name` = "notmy/repo" will not match ``` repositories: - name: willwright/githubwebhooks token: 123456 checks: BranchCheck: branches: [origin/develop] PathCheck: paths: [/^vendor\//] - name: '*' token: 123456 checks: PathCheck: paths: [/^somepath\//] - name: 'notmy/repo' token: 123456 checks: PathCheck: paths: [/^somepath\//] ``` Check Types ----------- [](#check-types) Checks are the Class that actually do work. Each **must** extend `\MeCodeNinja\GitHubWebhooks\Check\CheckAbstract`. Checks are made available for use to the Factory via `config/githubwebhooks.php`. This package comes with: - `\MeCodeNinja\GitHubWebhooks\Check\BranchCheck` - `\MeCodeNinja\GitHubWebhooks\Check\PathCheck` The Key used in the repository configuration can be found from `config/githubwebhooks.php`. They are: - BranchCheck - PathCheck ### BranchCheck [](#branchcheck) Branch request is designed to ensure that feature branch has not been forked from a particular branch and has not had a particular branch merged into it. Many teams follow the Git Branching strtegy in which all feature branches must be forked from master and if develop were to be merged in this would spoil the branch from being merged back into master. Branch check takes an array of strings. The Pull Request branch will be checked to verify it has not been forked from the branch in question. The Pull Request branch will be checked to make sure that it has not had the branch in question merged into it. Note that due to Git's commit and branchng internal architecture determining whether a branch has had another branch merged into it or not is not an exact science and this check is prone to false positives. Example ``` BranchCheck: branches: [origin/develop] ``` The example will result in the Pull Request branch being checked for `orign/develop` ### PathCheck [](#pathcheck) PathCheck is designed to ensure that a specific path has not been modified in a feature branch. Many modern applciations are built from frameworks or groups of modules. Best practice is to extend the libraries to create a unique functionality not to modify the libraries themselves. Path check takes an array of regular expression patterns. It will check the collection of changed files in the Pull Request for a match. If a match it found then the check will report a failure. Example ``` PathCheck: paths: [/^vendor\//] ``` The example will check the collection of changed paths in the Pull Request for `/vendor`. If found the check will report a failure. Extending --------- [](#extending) The developer may have their own checks that they want to perform. In order to create a new type of check the developer should 1. Create a new Check Class which extends `\MeCodeNinja\GitHubWebhooks\Check\CheckAbstract` 2. Implement the methods required by the interface 3. Register your Class in the `checks` array of `config/githubwebhooks.php` ### Health Score 26 — LowBetter than 43% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity7 Limited adoption so far Community9 Small or concentrated contributor base Maturity58 Maturing project, gaining track record Bus Factor1 Top contributor holds 97.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~111 days Recently: every ~139 days Total 6 Last Release 1911d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/5dd88c7142079520251d3e6909e614554eeeb7fd96c2117b57f714cee6ea284a?d=identicon)[mecodeninja](/maintainers/mecodeninja) --- Top Contributors [![guidance-automotan](https://avatars.githubusercontent.com/u/14352596?v=4)](https://github.com/guidance-automotan "guidance-automotan (40 commits)")[![willwright](https://avatars.githubusercontent.com/u/3172818?v=4)](https://github.com/willwright "willwright (1 commits)") --- Tags laravelgithub ### Embed Badge ![Health badge](/badges/mecodeninja-githubwebhooks/health.svg) ``` [![Health](https://phpackages.com/badges/mecodeninja-githubwebhooks/health.svg)](https://phpackages.com/packages/mecodeninja-githubwebhooks) ``` ### Alternatives [phpsa/laravel-postman Export laravel API routes to postman 1014.7k](/packages/phpsa-laravel-postman) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)