accompli/accompli

An easy to use and extendable deployment tool for PHP projects.

Accompli

![Build Status][ico-build] [][link-coverage] ![StyleCI][ico-code-style], _(*1)

An easy to use and extendable deployment tool for PHP projects., _(*2)

C'est fini. Accompli!, _(*3)

View the complete documentation of Accompli on accompli.readme.io., _(*4)

Installation using Composer

Run the following command to add the package to the composer.json of your project:, _(*5)

bash $ composer require accompli/accompli --dev, _(*6)

Versioning

Accompli uses Semantic Versioning 2 for new versions., _(*7)

Usage

1. Create an accompli.json defining the hosts to deploy to and the tasks to run during install and deployment., _(*8)

   By running the following command, Accompli will guide you in creating a basic accompli.json configuration: ``` bash $ vendor/bin/accompli init, _(*9)

   
   *Note that below example might not work for your project.*
   
   ``` json
   {
   "$extend": "accompli://recipe/defaults.json",
   "hosts": [
     {
       "stage": "test",
       "connectionType": "ssh",
       "hostname": "example.com",
       "path": "/var/www/example.com"
     }
   ],
   "events": {
     "subscribers": [
       {
         "class": "Accompli\\Task\\CreateWorkspaceTask"
       },
       {
         "class": "Accompli\\Task\\RepositoryCheckoutTask",
         "repositoryUrl": "https://github.com/example.com/example.com.git"
       },
       {
         "class": "Accompli\\Task\\DeployReleaseTask"
       },
       {
         "class": "Accompli\\Task\\MaintenanceModeTask"
       }
     ]
   }
   }
   

2. Run Accompli to install a release of your project: vendor/bin/accompli install-release <version>, _(*10)

3. Run Accompli to deploy an installed release of your project: vendor/bin/accompli deploy-release <version> <stage>, _(*11)

For a more detailed description on how to use Accompli, please see the getting started page., _(*12)

Credits and acknowledgements

• Niels Nijens
• Reyo Stallenberg creator of the name 'Accompli'

Also see the list of contributors who participated in this project., _(*13)

License

Accompli is licensed under the MIT License. Please see the LICENSE file for details., _(*14)