PHPackages aklump/post\_commit - 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. [DevOps & Deployment](/categories/devops) 4. / 5. aklump/post\_commit ActiveLibrary[DevOps & Deployment](/categories/devops) aklump/post\_commit =================== A post commit scheduler/runner for git repo pulling and auto deployment written in PHP focused on better security. 1.0.14(6y ago)230BSD-3-ClausePHPPHP >=5.3.0 Since Jun 28Pushed 6y ago1 watchersCompare [ Source](https://github.com/aklump/post_commit)[ Packagist](https://packagist.org/packages/aklump/post_commit)[ Docs](http://github.com/aklump/post_commit)[ RSS](/packages/aklump-post-commit/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (19)Used By (0) Post Commit =========== [](#post-commit) [![post_commit](images/screenshot.jpg)](images/screenshot.jpg) Summary ------- [](#summary) Provides an endpoint to your website to use as a webhook for git post commit hooks. When triggered the endpoint will queue a `git pull` to be executed by cron. This allows you to automate a deployment (plus whatever you want, e.g. Drupal cache clear), whenever you push to your repository. By leveraging cron, you can keep tight permissions and run your git pull as the cron user, not, say, `apache`. Intended to be used for staging websites, rather than production where you would want to deploy manually. **Visit [https://aklump.github.io/post\_commit](https://aklump.github.io/post_commit) for full documentation.** Quick Start ----------- [](#quick-start) ### Part 1 of 4 [](#part-1-of-4) 1. Install in your repository root using `cloudy pm-install aklump/post_commit` 2. Open *bin/config/post\_commit.yml* and set configuration. I encourage you to use wildcards for the repository and branch at first to get things working; you can tighten that up later. 3. Create the *logs* directory as configured in the previous step; be sure to **ignore this file** in SCM. 4. Open *bin/config/post\_commit.local.yml* and modify as needed; be sure to **ignore this file** in SCM. 5. Modify as needed and add *bin/auto\_deploy.sh* to SCM. 6. Run `./bin/post_commit init` to finish installing. 7. Give write permissions to both owner and group for *logs/\**, e.g. `chmod -R ug+w logs` > Pro Tip: Run `./bin/post_commit config-check` at any time to reveal configuration problems. ### Part 2 of 4: Test Endpoint [](#part-2-of-4-test-endpoint) 1. Determine the URL endpoint of the webhook, e.g., ``` https://{website}/scheduler.php?key={url_private} ``` 2. Begin monitoring the *pending.txt* log using `tail -f pending.txt`. 3. Open the endpoint in your browser, you should see something like: ``` origin user: repo: branch: * PHP user: apache 127.0.0.1 Tue, 30 Oct 2018 11:25:09 -0700 jobs added: 1 -------------------------------------------------------------------------------- ``` 4. Assert that the absolute path to the job is appended to *pending.txt*. 5. Begin monitoring the *complete.txt* log using `tail -f complete.txt`. 6. Manually run the jobs with `./bin/post_commit run`. 7. Assert you see output from your job in *complete.txt*. 8. If you wish to test your endpoint response to a certain repo or branch, use `?&repo={repo}&branch={master}`. ### Part 3 of 4: Register Web Hook [](#part-3-of-4-register-web-hook) 1. Log in to your server and `cd` to the logs directory. 2. Begin monitoring the *orders.txt* log using `tail -f orders.txt`. When you save your webhook below, you should see content appended--a new order--which indicates things are working correctly. It will resemble: ``` $ tail -f orders.txt origin user: aklump repo: aklump/post_commit branch: * -------------------------------------------------------------------------------- ``` 3. If you the site is HTTP Authorized, you will need to add credentials to the URL: ``` https://{user}:{password}@{website}/scheduler.php?key={url_private} ``` 4. Compile the post commit hook url and add it to your github project. - Keep the key in the url, do not use the secret textfield. - Choose the json format. - Make sure to use https if you can, a self-signed cert should work fine. - Save the webhook and check *orders.txt* for a change. [![GitHub Webhook](images/webhook.png)](images/webhook.png) ### Part 4 of 4: Setup cron job [](#part-4-of-4-setup-cron-job) 1. Set up a cron job to execute `./bin/post_commit run` and log the output. ``` * * * * * ./bin/post_commit run >> /path/to/.../logs/cron.txt ``` 2. Begin monitoring *cron.txt* using `tail -f cron.txt`. Wait for the next cron run and assert content was appended to *cron.txt*. 3. Now, test the whole setup by committing to your repo and asserting that *auto\_pull.sh* was indeed executed by cron. 4. Remove wildcards in the configuration `repository_name` and `branch_name` values as necessary. 5. Disable cron logging in your crontab with: ``` * * * * * ./bin/post_commit run > /dev/null ``` 6. Lastly, run `./bin/post_commit empty-logs` to flush all logs. 7. You're done. --- About the Log Files ------------------- [](#about-the-log-files) Rather than deleting log files, truncate them with `./bin/post_commit empty-logs`. This will maintain the correct permissions. basenamedescription*orders.txt*A running list of incoming pings.*last.json*The payload from the last ping.*pending.txt*Authorized jobs that are waiting to be run.*complete.txt*All jobs that have been run. These have been moved from pending.*cron.txt*Output from the cron job that controls the runner.Requirements ------------ [](#requirements) - You must have [Cloudy](https://github.com/aklump/cloudy) installed on your system to install this package. - Your repository may not use a passphrase, as this prevents the automatic git pull. Installation ------------ [](#installation) The installation script above will generate the following structure where `.` is your repository root. ``` . ├── bin │   ├── post_commit -> ../opt/post_commit/post_commit.sh │   └── config │   ├── post_commit.yml │   └── post_commit.local.yml ├── opt │ ├── cloudy │ └── aklump │ └── post_commit └── {public web root} ``` ### To Update [](#to-update) - Update to the latest version from your repo root: `cloudy pm-update aklump/post_commit` Configuration Files ------------------- [](#configuration-files) FilenameDescriptionVCS*post\_commit.yml*Configuration shared across all server environments: prod, staging, devyes*post\_commit.local.yml*Configuration overrides for a single environment; not version controlled.noscheduler.phpThis should be pinged by a post commit hook on the origin repo via https and including the secret key.yesUsage ----- [](#usage) - To see all commands use `./bin/post_commit help` Troubleshooting --------------- [](#troubleshooting) ### Jobs get scheduled but not run? [](#jobs-get-scheduled-but-not-run) 1. Check to make sure the the logs directory and all log files are owned by the cron user and the group is the php user and that both user and group has rw permissions. 2. Does the git repo require a passphrase for pulling? You will have to disable that. 3. Try logging in to the server as the cron user and running the command. 4. Make sure you can git pull manually using your ssh keys, etc. Contributing ------------ [](#contributing) If you find this project useful... please consider [making a donation](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4E5KZHDQCEUV8&item_name=Gratitude%20for%20aklump%2Fpost_commit). ### Health Score 29 — LowBetter than 60% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity10 Limited adoption so far Community7 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor1 Top contributor holds 100% 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 ~108 days Recently: every ~64 days Total 18 Last Release 2490d ago Major Versions 0.4 → 1.02018-10-30 ### Community Maintainers ![](https://www.gravatar.com/avatar/79476f3b82f9c766433c7eb401cbcfc636cd5d5ccf2b2e6b50ea81d1de6c2730?d=identicon)[aklump](/maintainers/aklump) --- Top Contributors [![aklump](https://avatars.githubusercontent.com/u/425737?v=4)](https://github.com/aklump "aklump (160 commits)") --- Tags gitauto-deploypost commit hooks ### Embed Badge ![Health badge](/badges/aklump-post-commit/health.svg) ``` [![Health](https://phpackages.com/badges/aklump-post-commit/health.svg)](https://phpackages.com/packages/aklump-post-commit) ``` ### Alternatives [banago/phploy PHPloy - Incremental Git (S)FTP deployment tool that supports submodules, multiple servers and rollbacks. 1.4k47.2k](/packages/banago-phploy)[pomander/pomander Deployment for PHP 19815.7k2](/packages/pomander-pomander)[fortrabbit/craft-copy Tooling for Craft on fortrabbit 7617.2k1](/packages/fortrabbit-craft-copy) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)