nDeploy is a phing based deploy script for php ecosystem, some idea borrowed from http://capifony.org. Currently deploy can be started only from a server.
- Symfony 5
- Symfony 3.x
- Symfony 2.x [composer based]
- Symfony 2.0.x [vendors based]
- Symfony 1.4
- Yii 1.1.x
- releases support
- composer support
- shared file handling (symlink based)
- maintenance mode ( http://shiftcommathree.com/articles/make-your-rails-maintenance-page-respond-with-a-503 )
- adding VCS based hash to files
- process locking
- Phing http://www.phing.info/
e.g. apt-get install phing - VersionControl_Git http://pear.php.net/package/VersionControl_Git
e.g. pear install VersionControl_Git-alpha - Composer https://getcomposer.org/ (optional, for composer based deployments)
git clone https://github.com/Netpositive/ndeploy.git
Run command, for config you project:
phing -f /path/where/you/installed/ndeploy/build.xml -q
Example:
user@dev:/srv/example.org$ phing -f /opt/ndeploy/build.xml -q
[echo] Welcome to ndeploy build.properties skeleton generator!
Application name? example
Application basedir [/srv/example.org]?
Application framework (yii,symfony2,symfony,) []?
Releases kept [100]?
SCM type (git,svn) [git]?
SCM repository? ssh://[email protected]/example.git
Shared files? vendor,app/config/parameters.yml,app/log.app/data
Vendor type(composer,sf2vendors,custom,none) [composer]?
Vendor command(install,update) [update]?
ndeploy lib [/opt/ndeploy/build.xml]?
[echo] Edit /srv/example.org/build.properties
BUILD FINISHED
Total time: 9.8417 secondsBuild xml is symlinked to the project directory, so you need to run only a phing command.
user@dev:/srv/example.org$ phingIf something goes wrong, phing can run with -verbose parameter.
;-- deploy basedir --
basedir=/srv/example.org
;-- application --
application.name=example
application.framework=symfony2
application.repositorydir=/srv/example.org/src/example
application.deploydir=/srv/example.org/current
application.releasesdir=/srv/example.org/releases
application.releaseskept=20
;-- scm properties --
scm.type=git
scm.repository=ssh://[email protected]/example.git
scm.ref=tags/latest
;-- shared files --
shared.files=vendor,app/config/parameters.yml,app/log.app/data
;-- vendor --
vendor=composer
vendor.command=update
;-- maintenance --
maintenance=true
maintenance.source=app/Resources/maintenance.html
maintenance.destination=web/maintenance.html
maintenance.remove=true
;-- hash --
hash=true
hash.file=app/config/parameters_assets.yml,app/config/parameters_assets_2.yml
;-- lock --
lock=true
lock.file=/srv/example.org/releases/ndeploy-example.lock
;-- ndpeloy build target's basedir --
ndeploy.basedir=~/src/ndeploy
The difference is the vendor=sf2vendors.
;-- deploy basedir --
basedir=/srv/example.org
;-- application --
application.name=example
application.framework=symfony2
application.repositorydir=/srv/example.org/src/example
application.deploydir=/srv/example.org/current
application.releasesdir=/srv/example.org/releases
application.releaseskept=20
;-- scm properties --
scm.type=git
scm.repository=ssh://[email protected]/example.git
scm.ref=tags/latest
;-- shared files --
shared.files=vendor,app/config/parameters.yml,app/log.app/data
;-- vendor --
vendor=sf2vendors
vendor.command=update
;-- maintenance --
maintenance=true
maintenance.source=app/Resources/maintenance.html
maintenance.destination=web/maintenance.html
maintenance.remove=true
;-- hash --
hash=true
hash.file=app/config/parameters_assets.yml,app/config/parameters_assets_2.yml
;-- lock --
lock=true
lock.file=/srv/example.org/releases/ndeploy-example.lock
;-- ndpeloy build target's basedir --
ndeploy.basedir=~/src/ndeploy
;-- deploy basedir --
basedir=/srv/example.org
;-- application --
application.name=example
application.framework=yii
application.repositorydir=/srv/example.org/src/example
application.deploydir=/srv/example.org/current
application.releasesdir=/srv/example.org/releases
application.releaseskept=20
; -- shared files --
shared.files=project/protected/runtime,project/www/backend/assets,project/www/frontend/assets,project/protected/config/local.php
;-- vendor --
;vendor=composer
;vendor.command=update
;-- maintenance --
maintenance=true
maintenance.source=app/Resources/maintenance.html
maintenance.destination=web/maintenance.html
maintenance.remove=true
;-- hash --
;hash=true
;hash.file=
;-- version --
;version=true
;version.file=
;-- lock --
lock=true
lock.file=/srv/example.org/releases/ndeploy-example.lock
;-- ndpeloy build target's basedir --
ndeploy.basedir=~/src/ndeploy
You can include your project specific build file, it will run at the end of the deploy process. File name must be ndeploy.xml
<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="/usr/share/php5/PEAR/data/phing/etc/phing-grammar.rng" type="application/xml" schematypens="http://relaxng.org/ns/structure/1.0" ?>
<project name="project.example" default="project.example.init">
<target name="project.example.init">
<phingcall target="project.example.helloworld" />
</target>
<target name="project.example.helloworld">
<echo msg="Hello world!" level="warning" />
<!-- Variables like ${basedir}, ${application.name} can be used -->
</target>
</project>You can override the deploy tasks order.
<!-- application tasks run order -->
application.run.pre=ndeploy.base.application.pre,ndeploy.scm.init,ndeploy.base.release.clean
application.run.init=ndeploy.base.shared,ndeploy.maintenance.init
application.run.release=ndeploy.base.release
application.run.after=ndeploy.vendor.init,ndeploy.framework.init,ndeploy.base.application,ndeploy.maintenance.remove,ndeploy.base.application.post
The easiest way is to start a docker container and mount the ndeploy source into it.
docker run --name ndpeloy-test --rm -it -v "$PWD":/opt/ndeploy -w /tmp debian bash
Install the required dependencies, then you're ready to play around with ndeploy.
apt-get update && apt-get install -y phing
phing -f /opt/ndeploy/build.xml -q