Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sarfraznawaz2005/gitup
Laravel package to upload git commits to server(s) via (s)ftp.
https://github.com/sarfraznawaz2005/gitup
deployment ftp laravel laravel-package upload
Last synced: 3 months ago
JSON representation
Laravel package to upload git commits to server(s) via (s)ftp.
- Host: GitHub
- URL: https://github.com/sarfraznawaz2005/gitup
- Owner: sarfraznawaz2005
- License: mit
- Created: 2018-04-30T06:27:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-01T13:24:29.000Z (over 5 years ago)
- Last Synced: 2024-10-11T20:14:28.215Z (4 months ago)
- Topics: deployment, ftp, laravel, laravel-package, upload
- Language: PHP
- Homepage:
- Size: 446 KB
- Stars: 20
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gitup
[](http://laravel.com)
[](http://laravel.com)
[](http://laravel.com)
[](http://laravel.com)
[](http://laravel.com)
[](https://packagist.org/packages/sarfraznawaz2005/gitup)
Laravel package to upload git commits to server(s) via (s)ftp.
## DISCLAIMER ##
This package is not fully tested, **use it at your own risk!**
## Screenshot ##
## Why ##
We have multiple servers eg live, staging, testing, etc and client wanted us to upload task/story # X to staging only or story Y to live only that's when it was hard to track down files worked upon earlier and then upload them selectively; a time consuming process and nuisance so we created this package so that we can easily upload with one click selected stories to asked servers.
## Requirements ##
- PHP >= 5.6
- `git` added to PATH env
- `FTP` and `Zip` PHP extensions (both ship with PHP and usually turned on)
- `league/flysystem` FTP wrapper used by gitUp. (comes with laravel by default)
- `league/flysystem-sftp` Library used by gitUp to upload files via SFTP.
## Installation ##
Install via composer
```
composer require sarfraznawaz2005/gitup
```
For Laravel < 5.5:
Add Service Provider to `config/app.php` in `providers` section
```php
Sarfraznawaz2005\GitUp\GitUpServiceProvider::class,
```
---
Run `php artisan vendor:publish` to publish package's config and migration file. You should now have `config/gitup.php` file published. It will also publish migration file in `database/migrations` folder.
Run `php artisan migrate` to create `commits` table in your database.
Check and update `config/gitup.php` file to setup config options including S(FTP) server information where you would like to upload.
By default, gitup UI is available at `/gitup` route.
## How it Works ##
For selected commits, we extract files out of them and create zip archive along with an script to extract this zip archive. The zip archive and extract script are then uploaded to selected server where extract script extracts the uploaded zip archive. Once the upload process is done, both zip archive and extract script are deleted from the server.
Uploading zip archive along with extract script has huge speed benefits as all committed files get uploaded in one shot as opposed to uploading each committed file individually.
## Similar Project ##
- [floyer](https://github.com/sarfraznawaz2005/floyer)
## License ##
This code is published under the [MIT License](http://opensource.org/licenses/MIT).
This means you can do almost anything with it, as long as the copyright notice and the accompanying license file is left intact.