Download the PHP package esameisa/check-git-branch-middleware without Composer
On this page you can find all versions of the php package esameisa/check-git-branch-middleware. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download esameisa/check-git-branch-middleware
More information about esameisa/check-git-branch-middleware
Files in esameisa/check-git-branch-middleware
Package check-git-branch-middleware
Short Description A middleware to check the current Git branch and prevent checkout of another one.
License MIT
Informations about the package check-git-branch-middleware
Check Git Branch Middleware
A Laravel middleware to check the current Git branch and prevent checkout of another one. This package ensures that your application only runs on the specified branch in production environments.
Installation
You can install the package via Composer. Run the following command in your terminal:
Configuration
After installing the package, you need to set the desired branch in your .env
file:
Publishing the Configuration File
and you can add those in .env file
branch_name
that mean force checkout again toBRANCH
abort_404
that mean force abort 404
Usage
To use the middleware, you need to register it in your app/Http/Kernel.php
file. Add it to the $middleware
array:
or if you want to put it only on some routes, Add it to the $routeMiddleware
array:
You can then apply this middleware to your routes or route groups:
How It Works
The middleware checks the current Git branch using the command:
If the current branch does not match the one specified in the .env
file and the application is running in a production environment, it will send an SMS notification and abort the request with a 404 status.
SMS Notification
This package uses the MoraSMS
service to send notifications. Ensure that you have this service set up and configured properly.
Example of Sending SMS
You can customize the SMS message sent during branch mismatch by modifying the code in the CheckGitBranchMiddleware
.
Contributing
Contributions are welcome! Please feel free to submit issues or pull requests.
- Fork the repository.
- Create your feature branch (
git checkout -b feature/AmazingFeature
). - Commit your changes (
git commit -m 'Add some AmazingFeature'
). - Push to the branch (
git push origin feature/AmazingFeature
). - Open a pull request.
License
This package is licensed under the MIT License. See the LICENSE file for more information.