Skip to content

famoser/agnes

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

agnes

releases safely to various environments, and allows to perform other common tasks.

install with

composer require famoser/agnes --dev

commands

php vendor/bin/agnes release v1.0 master creates the release v1.0 from the latest master
php vendor/bin/agnes deploy *:*:dev v1.0 installs the release v1.0 on all instances matching *:*:dev
php vendor/bin/agnes rollback *:*:dev rolls back instances matching *:*:dev to the previous release
php vendor/bin/agnes copy example:example.com:dev production copies the shared data to the instance matching example:example.com:dev from the production stage
php vendor/bin/agnes build master builds the master release; useful to test the build script
php vendor/bin/agnes run *:*:dev my_script runs the script called my_script on the *:*:dev instances
php vendor/bin/agnes clear *:*:dev clears surplus & invalid installations

for details on the commands use the --help argument.
to easily remember the order of arguments observe that the target is always first.

config

By default, the file called agnes.yml in your project root is taken as configuration (use --config-file to change).

Additionally to the config file you can supply a config folder which contains:

  • additional .yml files which will all be merged with the main config file (handy separate policies & server config )
  • other files which are needed for the installation but not part of the repository (like .env.local files)

In the config files, you can use placeholders like %env(KEY) which are replaced by environment variables upon loading the config. You can define environment variables in a .env or .env.local file in your project root.

Full example config in sample.yml.

advanced config

if you have an SSH connection configured you can speed up command execution greatly by caching the connection in ~/.ssh/config:

Host *
  ControlPath /tmp/ssh-%r@%h:%p
  ControlMaster auto
  ControlPersist yes

About

create & deploy releases safely to various environments

Topics

Resources

License

Stars

Watchers

Forks

Languages