mirror of
https://github.com/deployphp/deployer.git
synced 2025-02-23 08:45:04 +01:00
103 lines
3.3 KiB
Markdown
103 lines
3.3 KiB
Markdown
Introduction
|
|
------------
|
|
[](https://travis-ci.org/deployphp/deployer)
|
|
[](https://scrutinizer-ci.com/g/deployphp/deployer/)
|
|
[](https://codeclimate.com/github/deployphp/deployer)
|
|
[](https://scrutinizer-ci.com/g/deployphp/deployer/)
|
|
[](https://packagist.org/packages/deployer/deployer)
|
|
[](https://www.gittip.com/elfet)
|
|
|
|
[](https://insight.sensiolabs.com/projects/69072898-df4a-4dee-ab05-c2ae83d6c469)
|
|
|
|
|
|
Deployer is a deployment tool written in PHP.
|
|
|
|
See [http://deployer.org](http://deployer.org) for more information and documentation.
|
|
|
|
Deployer 3.0
|
|
============
|
|
Deployer 3.0 developing roadmap:
|
|
|
|
* [x] Refactor Source
|
|
* [x] Refactor tasks
|
|
* [x] Refactor servers
|
|
* [x] Refactor Deployer class
|
|
* [x] Refactor task execution
|
|
* [x] New features
|
|
* [x] Environment default values
|
|
* [x] Local tasks `->once()`
|
|
* [x] Server filters `->onlyOn(...)`
|
|
* [x] Parallel task execution (:gem: *WOW!* :gem:)
|
|
* [x] Better output
|
|
* [ ] Refactor recipes
|
|
* [ ] Refactor common recipe
|
|
* [ ] Refactor Symfony recipe
|
|
* [ ] New recipes
|
|
* [ ] Zend Framework recipe
|
|
* [ ] Laravel recipe
|
|
* [ ] WordPress recipe
|
|
* [ ] Yii recipe
|
|
* [x] Move repository from `elfet/deployer` to `deployphp/deployer`
|
|
* [x] New site on deployer.org
|
|
* [x] Separate docs and site code
|
|
* [x] Auto updating docs script
|
|
* [ ] Auto phar build script
|
|
|
|
|
|
Requirements
|
|
------------
|
|
* PHP 5.4.0 and up.
|
|
|
|
That's all!
|
|
|
|
You can install [ssh2 extension](http://php.net/manual/en/book.ssh2.php) to speedup deployment process and enable [sockets](http://php.net/manual/en/book.sockets.php) for parallel deployment.
|
|
|
|
|
|
Installation
|
|
------------
|
|
To install Deployer download [deployer.phar](http://deployer.org/deployer.phar) archive and move deployer.phar to your bin directory and make it executable.
|
|
|
|
~~~
|
|
mv deployer.phar /usr/local/bin/dep
|
|
chmod +x /usr/local/bin/dep
|
|
~~~
|
|
|
|
To upgrade Deployer run command:
|
|
|
|
~~~
|
|
dep self-update
|
|
~~~
|
|
|
|
Or via composer:
|
|
|
|
~~~
|
|
composer require deployer/deployer:~3.0
|
|
~~~
|
|
|
|
|
|
Documentation
|
|
-------------
|
|
Documentation source can be found in [deployphp/docs](https://github.com/deployphp/docs) repository.
|
|
|
|
|
|
Building
|
|
--------
|
|
To build `deployer.phar` run `bin/build` command.
|
|
|
|
|
|
Contributing
|
|
------------
|
|
All code contributions must go through a pull request and approved by a core developer before being merged.
|
|
This is to ensure proper review of all the code.
|
|
|
|
Fork the project, create a feature branch, and send a pull request.
|
|
|
|
To ensure a consistent code base, you should make sure the code follows
|
|
the [PSR-1](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md).
|
|
|
|
If you would like to help take a look at the [list of issues](https://github.com/deployphp/deployer/issues).
|
|
|
|
License
|
|
-------
|
|
Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
|