mirror of
https://github.com/deployphp/deployer.git
synced 2025-02-23 08:45:04 +01:00
69 lines
1.9 KiB
Markdown
69 lines
1.9 KiB
Markdown
Introduction
|
|
------------
|
|
[](https://travis-ci.org/elfet/deployer)
|
|
|
|
Deployer is a deployment tool written in PHP.
|
|
|
|
See [http://deployer.in](http://deployer.in) for more information and documentation.
|
|
|
|
|
|
Requirements
|
|
------------
|
|
Deployer is only supported on PHP 5.4.0 and up (yes, it's time to grow up).
|
|
Deployer work with ssh2 pecl extension, but if you do not install it on you machine - do not worry,
|
|
Deployer will work with [PHPSecLib](https://github.com/phpseclib/phpseclib).
|
|
|
|
|
|
Installation
|
|
------------
|
|
To install Deployer download [deployer.phar](http://deployer.in/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 elfet/deployer:*
|
|
~~~
|
|
|
|
|
|
Documentation
|
|
-------------
|
|
Documentation can be found on site [deployer.in](http://deployer.in).
|
|
|
|
|
|
Building
|
|
--------
|
|
To build deployer.phar run `./build` command.
|
|
|
|
To create new release, clone this repository at `pages` dir, checkout `gh-pages` branch and run `./build -v=VERSION`.
|
|
This command will create phar archive in `pages/releases` dir and automatically updates `manifest.json` file.
|
|
|
|
|
|
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 [Coding Standards](http://symfony.com/doc/master/contributing/code/standards.html)
|
|
which borrowed from Symfony.
|
|
|
|
If you would like to help take a look at the [list of issues](https://github.com/elfet/deployer/issues).
|
|
|
|
|
|
License
|
|
-------
|
|
Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
|